HyDE-Project_HyDE/CONTRIBUTING.md

Contributing to Community Standards

Thank you for your interest in contributing to Community Standards! We welcome any contributions, including bug fixes, feature enhancements, documentation improvements, and other general improvements.

Getting Started

1. Fork this repository to your GitHub account. This will create a copy of this repository in your account. You can make changes to this copy without affecting the original repository.

   • For fork this repository, click the Fork button in the top right corner of this page or click here.

Note

For first-time contributors:** All new contributors should start by submitting pull requests. After demonstrating consistent high-quality contributions through PRs, you may be considered for a collaborator role as described in TEAM_ROLES.md. Direct repository access is granted selectively based on contribution history.

2. Clone your forked repository to your local machine.

   • Use the following command to clone your forked repository to your local machine.

     git clone https://github.com/HyDE-Project/HyDE.git
     

3. Create a new branch for your changes.

   • For example, to create a new branch named your-branch-name, use the following command.

     git checkout -b your-branch-name
     

4. Make your changes and commit them with a descriptive commit message.

   • For example, to commit your changes, use the following command and make sure to follow the commit message guidelines.

     git commit -m "feat: add a new feature"
     

5. Code should be documented where appropriate.

• Changes compared to the latest HyDE release which have a direct effect on the user (opposed to things like code refactorings or documentation/tests) additionally need to be documented in the CHANGELOG.md
• The existing entries should be used as a style guideline.
• The change log should be used to document changes from a user-perspective, instead of explaining the technical background (like commit messages) More information about HyDE's change log format can be found here.

5.1. Optional But Recommended: Test with HydeVM - You can test your changes in a VM using HydeVM before submitting.

6. Push your changes to your forked repository.

   • For example, to push your changes to your forked repository, use the following command.

     git push origin your-branch-name
     

7. Submit a pull request to the upstream repository.

   • Important: Always submit your pull requests to the dev branch, not directly to master. Following the RELEASE_POLICY.md, changes go through the dev branch first for testing before being merged into master during the release window.
   • For example, to create a pull request, use the following steps.
     1. Go to your forked repository.
     2. Click the Compare & pull request button next to your your-branch-name branch.
     3. Make sure the base repository branch is set to dev.
     4. Add a title and description for your pull request.
     5. Click Create pull request and remember to add the relevant labels with using the pull request template.

Guidelines

• Follow the code style of the project.
• Update the documentation if necessary.
• Add tests if applicable.
• Make sure all tests pass before submitting your changes.
• Keep your pull request focused and avoid including unrelated changes.
• Remember to follow the given files before submitting your changes.
  • bug_report.md - Use this template to create a report to help us improve.
  • feature_request.md - Use this template to suggest a feature for this project.
  • documentation_update.md - Use this template to propose a change to the documentation.
  • custom.md - Use this template to submit a custom issue.
  • PULL_REQUEST_TEMPLATE.md - Use this template to submit a pull request.
  • COMMIT_MESSAGE_GUIDELINES.md - Read this file to learn about the commit message guidelines.
  • CONTRIBUTING.md - Read this file to learn about the contributing guidelines.
  • RELEASE_POLICY.md - Read this file to understand the release cycle, branch management, and deployment schedule.
  • TEAM_ROLES.md - Learn about the different roles in our project (Collaborators, Triagers, and Testers) and how to join.
  • LICENSE - Read this file to learn about the license.
  • README.md - Read this file to learn about the project.

Contact

If you have any questions, feel free to contact via GitHub Discussions.