Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 1.69 KB
Raw

Contribution Guidelines

Submitting issues, questions, and feature requests

Issues with existing functionality, questions, and feature requests can be submitted here. Before submitting a new issue, search through the existing open and closed issues to see if your issue has already been reported.

Fixing bugs and adding features

Before making modifications to our code, familiarize yourself with our coding guidelines. Once you are familiar with our guidelines, our process for fixing bugs and adding features is as follows.

  1. Submit an issue describing the changes you want to implement. If it's a minor change or bug fix, you can skip to step 3.

  2. After the scope is discussed in the issue, assign it to yourself.

  3. Fork our repository and clone it locally.

git clone --recurse-submodules https://github.com/<your-github-username>/spear <local-path-to-spear>
  1. Create a branch with a concise and meaningful name that describes the scope of the work.
git checkout -b <branch-name>
  1. Make your changes, write good commit messages, push your branch to the forked repository:
git add <modified-file>
git commit -m <meaningful description>
git push --set-upstream origin <branch-name>

  1. Make sure your branch is fully up-to-date with all of the latest changes in our main branch.

  2. Create a pull request in the GitHub web interface and link the issue you submitted in step 1 to the pull request.

  3. Address all feedback you receive and push it to your fork. The pull request will get updated automatically.

  4. We will merge your pull request into our main branch when it is ready.