Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 2.03 KB
Raw

Contributing

As the code basis in this repository have been purely developed for personal usecases, but your contributions are always welcome! Please carefully read this page to make the code review process go as smoothly as possible and to maximize the likelihood of your contribution being merged.

Bug Reports

For bug reports or requests submit an issue. With leveraging GitHub features, we have an issue template for reporting bugs. Please feel free to use it for reducing your time.

Pull Requests

The preferred way to contribute is to fork the main repository on GitHub. The brief procedures to fork this repo are described below, still we are also welcome if you would directly make PRs within this repository instead of forking.

  1. Fork the main repository. Click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.

  2. Clone this copy to your local disk:

$ git clone git@github.com:${YOUR_USERNAME}/GH_REPONAME.git
$ cd GH_REPONAME
  1. Create a branch to hold your changes and start making changes.
$ git switch --create ${YOUR_BRANCH_NAME}
  1. Work on this copy on your computer using Git to do the version control. When you're done editing, run the following to record your changes in Git:
$ git add ${MODIFIED_FILENAME} [ ${MODIFIED_FILENAME} ... ]
$ git commit
  1. Push your changes to GitHub with:
$ git push -u origin ${YOUR_BRANCH_NAME}
  1. Finally, go to the web page of your fork of the GH_REPONAME repo and click 'Pull Request' to send your changes for review.

GitHub Pull Requests Docs

If you are not familiar with pull requests, review the pull request docs.