Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

85 lines (52 loc) · 3.21 KB
Raw

Contributing to git-recognise

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Getting Started

Fork the Repository

To get started, fork the git-recognise repository to your GitHub account. You can do this by clicking the "Fork" button on the top right of the repository page.

Making Contributions

Creating Issues

Before you start working on a contribution, check if there's an existing issue related to your idea or bugfix. If not, create a new issue describing the problem you want to solve or the feature you'd like to add. This helps ensure that your contribution aligns with project goals.

Making Changes

  1. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/git-recognise.git

  2. Create a new branch for your contribution:

    git checkout -b feat/<feature name>

  3. Make your changes

Documentation

Ensure your changes are well-documented. If you're introducing new features or modifying existing functionality, update the project's documentation accordingly.

Submitting Pull Requests

When your contribution is ready, follow these steps to submit a pull request:

  1. Commit your changes and push them to your forked repository:

    git add .
git commit -m "Add my feature"
git push origin feat/<feature name>

  2. Visit the original git-recognise repository on GitHub.

  3. Click the "New Pull Request" button.

  4. Select your branch (e.g., feat/<feature name>) as the base branch to merge into the main project.

  5. Provide a clear and concise description of your pull request, including the problem it solves or the feature it adds.

  6. Submit the pull request.

Review Process

Contributions to git-recognise will be reviewed by project maintainers. They may provide feedback, request changes, or approve your pull request. Please be patient and responsive during this process.

License

By contributing to git-recognise, you agree that your contributions will be licensed under the CC0 1.0 Universal (CC0 1.0) License.

Thank you for contributing to git-recognise! Your help is invaluable in making this project a success.