Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.6 KB

Contributing

The UQCS site is a place to show off both the club itself, and the work its members. You can contribute ideas, bugs or suggestions by clicking the Issues tab above and creating a new issue.

You can contribute code by forking the repository, making your changes and creating a pull request. It's encouraged to create an issue for the changes you plan on making in your pull request and you should mention the IDs of any issues you work on in your pull request description.

Want help with creating a pull request? No problem! Email us at [email protected] for help, or jump onto Discord and ask in #projects for advice.

Please note we have a code of conduct, please follow it in all your interactions with the project.

The Contribution Process

  1. Find an issue that you want to take on and assign yourself to it, or create an issue for the work you are about to do.
  2. Create a branch to begin work on either using the GitHub UI, or via your command line.
  3. Checkout the branch locally and work on your issue.
  4. When you are finished on your feature/issue, push it to the remote repository and create your pull request.
  5. Request a review from one of the reviewers listed in the reviewers section of this document.
  6. When your pull request is reviewed and approved, click Squash and Merge, clear the commits from below the merge title, then confirm.

If the steps above are unclear, jump onto Discord and ask in #projects for advice.

Reviewers

When merging a pull request, make sure you have received a review from one of the following people:

If you want to add yourself to this list, make a PR and request review from someone above.

Documentation