Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 2.56 KB
Raw

Recipe Hunter Contributing

Thank you for considering contributing to Recipe Hunter! We appreciate your help in making this project better. Before you get started, please take a moment to read and complete this contributing test to ensure that your contributions align with the project's guidelines and quality standards.

Step 1: Check the Issues

  1. Visit the GitHub Issues page of the Recipe Hunter project.
  2. Search for an existing issue that you are interested in working on or create a new one if your contribution is related to a bug, enhancement, or a new feature.

Step 2: Fork the Repository

  1. Fork the Recipe Hunter to your GitHub account.

Step 3: Clone Your Fork

  1. Clone your forked repository to your local machine using Git. 
    git clone https://github.com/yourusername/recipe-hunter.git

Step 4: Create a New Branch

  1. Create a new branch with a descriptive name for your contribution. 
    git checkout -b feature/my-new-feature

Step 5: Make Your Changes

  1. Make the necessary changes and improvements in your local branch.

Step 6: Test Your Changes

  1. Ensure your changes do not break the existing functionality.
  2. Test your new code and make sure it follows the project's coding guidelines.

Step 7: Commit Your Changes

  1. Commit your changes with a clear and concise commit message. 
    git commit -m "Add feature: Description of the changes"

Step 8: Push Your Changes

  1. Push your changes to your forked repository. 
    git push origin feature/my-new-feature

Step 9: Create a Pull Request

  1. Visit the Recipe Hunter repository on GitHub: RecipeHunter.
  2. Click the "New Pull Request" button.
  3. Select the branch you just pushed and create the pull request.
  4. Provide a clear and concise description of your changes and reference the related issue, if applicable.

Step 10: Review and Discussion

  1. Be prepared to engage in a discussion about your pull request.
  2. Address any feedback or changes requested by the maintainers.
  3. Be patient as the maintainers review your contribution.

Step 11: Merge and Close

  1. Once your pull request is approved, a project maintainer will merge it.
  2. Congratulations! Your contribution has been merged into Recipe Hunter.

Thank you for your interest in contributing to Recipe Hunter. Your help is greatly appreciated. If you have any questions or need assistance, please don't hesitate to ask.

Happy coding!