CONTRIBUTING.md

Welcome to SahaBee contributing guide

Thank you for investing your time in contributing to SahaBee! Any contribution you make will be reflected on sahabee.ir ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Getting started

Here are various ways of contributing to SahaBee.

Issues

Create a new issue

If you spot a problem with SahaBee, search if an issue already exists.

Solve an issue

Scan through our existing issues to find one that interests you. There may be some issues labeled as good first issue; these issues are best fits for contributing for the first time, as they're general, simplified, and clear enough to get the hands on.
As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

1. Install Git LFS.

2. Fork the repository.

   • Using GitHub Desktop:
     • Getting started with GitHub Desktop will guide you through setting up Desktop.
     • Once Desktop is set up, you can use it to fork the repo!
   • Using the command line:
     • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

3. Install Docker and Docker Compose. For more information, see Docker Engine overview.

4. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. See Git Commit Style Guide to know how commit messages should look like.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

• We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
• As you update your PR and apply changes, mark each conversation as resolved.
• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 SahaBee thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the repo.

Now that you are part of the SahaBee community.

References

The structure of this contributing guide is copied from the GitHub docs version. Thanks to GitHub for sharing such docs!