Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 4.77 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 4.77 KB
Raw

What kinds of contributions are we looking for?

We love receiving contributions from anyone who would love to. Any assistance you can provide with regards to bug fixes, feature enhancements, and documentation is more than welcome.

Contributing

Please ensure all pull requests and contributions comply with the Developer Certificate of Origin.

Setting Up Your Code

First, fork this repository to your own account. Then use git clone <url> to bring your forked repository down to your local machine (remember to get the URL for your repository, not the original). Optionally, use git remote add upstream <url> to add the original repository as the upstream (this is helpful for keeping your fork up-to-date).

Claiming an Issue

All of our issues are open to contributors! If you see an open issue you would like to work on, please comment on the issue so we may assign it to you.

NOTE: Assigned issues that have not had any activity in a week will be unassigned.

If an issue is already assigned, please look for another issue to contribute to.We use labels to help categorise issues:

  • good first issue - These issues require minimal familiarity with our codebase. Please reserve these for first-time contributors.
  • help wanted - These issues are open to any contributors.
  • staff only - These issues are locked to project members/collaborators. Pull requests on these issues will not be accepted from outside contributors.

Working on your issue

Before starting work, we highly recommend ensuring that your forked version is up to date. If you set the upstream as mentioned in Setting Up Your Code, run these commands in your terminal (with the terminal pointed at the root directory of your local files):

  • git fetch upstream - this gets the current state of the original repo, without pulling down the changes to your local machine.
  • git reset --hard upstream/main - this resets the state of your local files to match the current state of the original repo.
  • git push -f - this forces the changes to your forked repo (thus making it match the original)

NOTE: You will lose any changes you are currently working on. Do this with care.

Next, use git checkout -b <branchname> to create a new branch for your work. It's always a good idea to avoid committing changes directly to your main branch - this keeps it clean and avoids errors when updating (above).

Branch names should follow a convention of scope/issue?/description where:

  • scope is the nature of the changes (eg. feat for a new feature, or docs for documentation update). This should match the scope of the related issue.
  • issue is the number for the related issue you're addressing.
  • description is a brief description of your changes, such as update-contribs for updating the contributing guidelines.

Now you are free to work on your code! When you are satisfied with your changes, you can commit them with git commit -s -m "message", where:

  • -s flag signs the commit, to verify the connection with your GitHub account.
  • -m flag sets up the commit message.
  • message is the commit message: a brief (50 character max) message describing what the commit changes.

Submitting a Pull Request

Once you have all of your changes made and committed, you can push them to your forked repository! Use git push -u origin <branchname>, where:

  • -u tells git to set the upstream (see below)
  • origin tells git to push to your fork
  • branchname tells git to push to a branch - this MUST match the name of the branch you created locally.

NOTE: By setting the upstream, any subsequent push commands can be done with git push, and it will be pushed to the same branch.

Now you can open the pull request! You should see a quick option to do so appear at the top of your repository on GitHub. Click the "Pull Request" button to have GitHub automatically set up the pull request.

First, change the title of the pull request to match your branch name (following the conventions above!). Then, follow the instructions in the preset Pull Request template (make sure to complete any steps listed!).

Congratulations! You've submitted your first pull request! We will review it as quickly as possible, so keep an eye out for approvals (or requested changes).

Other Contributions

If you aren't comfortable with the codebase, or would like to contribute in other ways, we have options for that!

  • Documentation Updates: You are always welcome to update our documentation (like this file!) if you see any typos or anything that can be clarified.
  • Feature Requests: If you have ideas for new features or improvements, feel free to open an issue!
  • Bug Reports: We rely on our users to help identify bugs - if you see something wrong, please let us know with an issue!