-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing
Vabolos edited this page Jan 14, 2025
·
1 revision
We love contributions! 🎉 Thank you for considering contributing to PowerModule. This page will guide you through the process of contributing effectively.
- 🍴 Fork the repository: Click on the "Fork" button at the top right of the repository page to create a copy of the repository in your GitHub account.
- 🌿 Create your feature branch: Clone your forked repository to your local machine and create a new branch for your feature or bug fix:
git checkout -b feature/AmazingFeature
- 💾 Commit your changes: Make your changes and commit them with a clear and descriptive commit message:
git commit -m 'Add AmazingFeature: Description of what this commit does'
- Use imperative mood in the commit message (e.g., "Add", "Fix", "Update").
- Reference any related issues or pull requests in the commit message (e.g., "Fixes #123").
- 📤 Push to the branch: Push your changes to your forked repository:
git push origin feature/AmazingFeature
- 📬 Open a pull request: Go to the original repository and open a pull request (PR) from your branch. Provide a clear title and description for your PR. Make sure to:
- Describe the purpose of the PR.
- Include any relevant issue numbers (e.g., "Closes #123").
- Highlight any important changes or new features.
- Use meaningful messages: Each commit message should clearly describe what the commit does.
- Be concise but descriptive: Aim for a single line that summarizes the change.
- Reference issues: If your commit addresses an issue, reference it in the commit message (e.g., "Fixes #123").
- Provide a clear title: The PR title should summarize the changes.
- Describe the changes: In the PR description, explain what changes were made and why.
- Link to issues: Reference any related issues or PRs.
- Add screenshots or examples: If your changes affect the UI or output, include before and after screenshots or examples.
- Be responsive: Participate in the review process by responding to feedback and making necessary changes.
- Follow existing code style: Maintain consistency with the existing codebase.
- Use comments: Add comments to explain complex logic or important sections of the code.
- Write tests: If applicable, write tests to cover your changes.
If you need help or have questions, feel free to:
- Open an issue on the GitHub repository.
- Join our community discussions on GitHub.
By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand our expectations for contributors.
Thank you for contributing to PowerModule! Your support and contributions help make this project better for everyone. Let's build something amazing together! 🚀