Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (51 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

82 lines (51 loc) · 3.32 KB

Contributing Pull Requests

We use a Draft Pull Request workflow to manage contributions effectively.

This tab is the central space for communication to see what peers are working on.

image

Choosing an issue to work on

  1. Pick and issue from the Issues tab, consider using a suitable filter like good first issue. (See also CONTRIBUTING_issues_tab.md)
  2. Check the Pull Requests Tab.

How to contribute a pull request

  1. Submit an initial commit and convert to a pull request.
  2. convert your pull request to draft (illustration below)
  3. reference the existing issue with the # feature e.g. #134.
  4. convert the PR to an open pull request when ready!
click here: how to draft a pull request

image

What to include before completing a pull request

  1. pull from main branch to ensure no merge conflicts between branch and main
  2. run cd frontend; npm run build causing no typescript errors
  3. include # in description e.g. #243. This links the pull request to issue(s) solved
  4. add screenshots and or screen recordings of the new outcome

Optional: to request the code owner team to manually test the branch in their IDE, you can add the label action required: manual testing

template provided here.

Roles

  • Everyone is a contributor.
  • The Code owners have the additional role to review + merge the pull requests.
  • Our current code owners are Laurie, Joseph, Aznim and Viola -- feel free to reach out to us on the Discord channel :)
  • As per the branch rules, 1 code owner approval is sufficent to merge a Pull Request.

Code owner guidance for reviewing Pull Requests.

  1. Review description of PR, check for steps 1-4 mentioned above.
  2. Assign a relevant label if necessary for action required.
  3. Review the files changed tab.
  4. Approve when ready.
  5. Merge.

example labels:

image

Frequently asked Questions

Q: How do I get assigned to an issue? A: The best way to self-assign is by drafting a Pull Request. Just check the Pull Requests Tab for potential overlap.

Q: I want to work on an issue. Is it acceptable to pull request an initial commit with no changes? A: Yes! Just make sure it is marked as draft.

Q: I want to work on an issue but someone has started working on it in the Pull Request drafts. A: If someone has started on the Pull Requests Tab, consider reaching out to that peer in the comments and offering to contribute an isolated issue to their branch.

Using the issues tab

Please read CONTRIBUTING_issues_tab.md for further guidance on using the issues tab.

join our discord channel

image

if you haven't already: