Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 3.81 KB

Contributing.md

File metadata and controls

60 lines (44 loc) · 3.81 KB
Raw

Contributing

Thank you for your interest in contributing to Shared-Backpack-docs. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated.

If you are new to contributing to open source, please read the Open Source Guides on How to Contribute to Open Source.

Ways to Contribute

If you are ready to start contributing code right away, we have a list of good first issues that contain issues with a limited scope.

Quicklinks

Our Development Process

We utilize GitHub issues and pull requests to keep track of issues and contributions from the community.

Issues

Make sure you are following issue report guidelines available here before creating any new issues on Shered-Backpack API project.

Pull Requests

Pull Request guidelines is best resource to follow to start working on open issues.

Git Flow

For Shared-Backpack-docs, we utilize the GitFlow branching model. GitFlow is geared towards efficiently tracking development and managing releases. The model makes parallel development efforts easy and safe by isolating new development efforts from completed work.

The different types of branches we may use are:

  • Feature branches (feature/branch-name)
  • Release branches (release/1.XX)
  • Bug branches (bugfix/branch-name)
  • Hotfix branches (hotfix/branch-name)

Detailed document containing how GitFlow works: https://nvie.com/posts/a-successful-git-branching-model/

Contributing Code

Code contributions to Shared-Backpack-docs come in the form of pull requests. These are done by forking the repo and making changes locally.

Make sure you have read the Documentation for Setting up the Project

The process of proposing a change to Shared-Backpack-docs can be summarized as:

  1. Fork the Shared-Backpack-docs repository and branch off master.
  2. The repository can be cloned locally using git clone <forked repo url>.
  3. Make the desired changes to the Shared-Backpack-docs source.
  4. Run the website and test your changes.
  5. If you've added code that should be tested, write tests.
  6. After making changes you can add them to git locally using git add <file_name>(to add changes only in a particular file) or git add . (to add all changes).
  7. After adding the changes you need to commit them using git commit -m '<commit message>'(look at the commit guidelines below for commit messages).
  8. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: git push origin <branch_name>.(Here branch name must be name of the branch you want to push the changes to.)
  9. Now create a pull request to the Shared-Backpack-docs repository from your forked repo. Open an issue regarding the same and link your PR to it.
  10. Ensure the test suite passes, either locally or on CI once a PR has been created.
  11. Review and address comments on your pull request if requested.

Community

The Incentive Coders has a Slack channel where members can assist with support and clarification. Click here to join our slack channel. The Incentive Coders has a LinkedIN page. Click here to follow our LinkedIN page.