Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.31 KB

Contribution Guidelines

Thank you for considering contributing to ENVYZ! We value the contributions of our community and welcome any improvements, bug fixes, and new features that you can bring to the project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine:
  3. Create a new branch for your feature or bug fix:
  4. Make your changes, commit them, and push to your forked repository:
  5. git push origin bugfix-name

Code Style

  • Follow the existing code style and conventions used in the project.
  • Use descriptive variable and function names for better readability.
  • Write clear and concise comments to explain complex logic or functionality.

Testing

  • If you're adding a new feature, consider adding corresponding tests to ensure its correctness.
  • Run the existing test suite before pushing your changes:

Pull Request

  • Open a pull request (PR) against the main branch of the original repository.
  • Provide a clear and detailed description of your changes in the PR.
  • Include any relevant information that might help reviewers understand your work better.
  • Ensure that your PR title is descriptive and meaningful.

Code Review

  • Be responsive to feedback and be prepared to make additional changes if required.
  • Be open to constructive criticism and suggestions from the community.

Licensing

  • Make sure that your contributions are compliant with the GNU General Public License (GPL).
  • By submitting a PR, you are acknowledging that your changes will be covered under the same license.

Issue Reporting

  • If you encounter any bugs or issues, please check the existing issues first to see if it's already reported.
  • If not, feel free to open a new issue, including a clear description of the problem and steps to reproduce it.

Documentation

  • If you're adding new features or making significant changes, update the relevant documentation.
  • Keep the README.md file up-to-date with any changes that may be relevant to users.

Thank you for your interest in contributing to Envzy. Your efforts will be recognized and will help improve the experience for all users. Happy coding!