Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

71 lines (48 loc) · 3.05 KB

Contributing to BrewNotes

Thank you for considering contributing to BrewNotes. I welcome contributions from everyone, regardless of your level of experience. This document will guide you through the process and help you get started as a newbie contributor.

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top right of the repository's page on GitHub. This creates a copy of the project in your GitHub account.

  2. Clone Your Fork: Open a terminal or command prompt and run the following command, replacing <your-username> with your GitHub username:

    git clone https://github.com/<your-username>/<your-project-name>.git

  3. Set Up Remote: Change into the project's directory:

    cd <your-project-name>

    Connect your fork to the original repository:

    git remote add upstream https://github.com/<original-author>/<your-project-name>.git

  4. Create a Branch: Before making changes, create a new branch for your work. Name it in a way that reflects the nature of your contribution.

    git checkout -b my-new-feature

Making Changes

  1. Code: Make your code changes or additions.

  2. Testing: If appropriate, ensure your changes don't break existing functionality, and write tests for any new features.

  3. Documentation: Update the project's documentation if needed.

  4. Commit: Commit your changes with a descriptive commit message.

    git commit -m "Add new feature"

  5. Sync with Upstream: Before submitting a pull request, ensure your branch is up to date with the latest changes from the original repository.

    git fetch upstream
git rebase upstream/main

Submitting Your Contribution

  1. Push to Your Fork: Push your changes to your GitHub fork.

    git push origin my-new-feature

  2. Create a Pull Request: Go to your fork on GitHub, switch to your branch, and click "New Pull Request." Provide a descriptive title and any additional information about your changes.

  3. Review: We will review your changes and may request additional updates or changes before merging.

What's Next?

Congratulations! You've successfully contributed to [Your Project Name]. If you have any questions, feel free to ask in the comments section of your pull request. We're here to help you!

We value and appreciate your contributions, whether they are big or small. Thank you for helping make this project better.

Code of Conduct

Just open a pull request and create an issue for the fix that you've made in the code. Use images or GIFs if required.

Please note that as a contributor, you are expected to follow the project's Code of Conduct. This ensures a welcoming and inclusive community for all.

You can customize this template with your project-specific details and add any additional information that might be relevant to your project. Make sure to include a Code of Conduct as well to maintain a positive and inclusive community.