There are many ways to be a contributor, and we're here to help you on your way! You may:
This section is designed to help you make an edit if you aren't familiar with using GitHub and want to make a change to any repository.
If you're not familiar with GitHub and Git, here are a few simple steps you can use to get going and contribute to the repository without ever touching the command line.
There is also a Video Walkthrough of how to do this if you prefer to learn over video.
Find the file you want to edit. Click the pen tool on the top right of the file to edit it. If you want to add a file, click "Add File". Click "Create new branch". Learn More
Make your changes. When you are ready, click Pull Request on the bar above the file. Then create New Pull Request
and choose to set the request to merge to the main
branch. Put any information you want to describe your changes in the description, and you're done! Learn More.
If you've gotten some comments about needing to fix a PR, the process is really simple. You do NOT need to create a new PR.
Go to the file in your branch that you want to edit.
Click the edit button ( step 2 from when you created the initial edit )
Make edits, but this time, instead of creating a new branch, commit to the same branch. Your changes will propagate to the PR.
You may want to re-request a review. Click the sync button to do so:
As a more advanced user, there are a few ways you can manage your GitHub repository:
main
branch. All changes must occur over a PR and off the main branch.<type>/<description>
ex. edit/fix-fig4-label
.main
.The below documents some basic best practices for your pull requests.
status: needs-review
should contain a PR code OR the change text directly in the issue (for those not Git-savvy)status: needs-review
label to the issue/PR.accepted
-labelaccepted
editor
may change the status to status: last-call
. This would signal a 5-day delay for close.status: last-call
, the issue is accepted and merged back into main
.Priority labels are used to describe the impact and focus of the issue. Higher priority means it is more likely to find focus within the group.
Priority | Label | Usage |
---|---|---|
priority | critical | Progress on this issue is critical to the group's forward progress. |
priority | high | It is important for the group to resolve this issue soon. |
priority | medium | This issue is important to resolve before the next release. |
priority | low | This issue is "nice to have" for the next release, but could be deferred if time runs out. |
Type labels are labels the define the nature of the issue and/or the correction itself.
Type | Label | Usage |
---|---|---|
type | editorial | The issue only involves wording and not normative content. |
type | content | The issue involves normative content; resolution requires group consensus. |
type | correction | The issue is fixing a recognized problem in the current version. |
type | formatting | The issue involves fixing formatting. |
type | figure | The issue involves a figure that it missing or needs to be revised. |
type | admin | The issue is administrative and NOT about the deliverable. |
Status labels are labels that are used to help identify the current state of the issue, so that we may accurately classify the work to do on it.
Status | Label | Usage |
---|---|---|
status | unassigned | The issue is new and has not yet been assigned to anyone. |
status | in-progress | The issue has been assigned and work is in progress. |
status | needs-review | A resolution (or concrete step forward) has been proposed and needs review. |
status | blocked | Progress is currently blocked; the block should be explained in a comment. |
status | on-hold | Progress is currently on hold; the reason should be explained in a comment. |
status | deferred | Consensus has been reached that this issue can be deferred to a subsequent version. |
status | abandoned | Consensus has been reached that this issue can be abandoned. |
status | PR-needed | Consensus has been reached and this issue is now waiting for a PR to be submitted. |
status | PR-in-progress | The issue is linked to a PR that is in progress |
status | PR-completed | The issue is linked to a PR that is complete and waiting for review. |
status | PR-accepted | The issue is linked to a PR that has been accepted and is waiting for merge. |
status | PR-merged | The issue is linked to a PR that has been merged; this issue can now be closed. |
status | status: last-call | The issue has been resolved by some other mechanism documented in the comments and is now in the 5-day last call. |
Attribution:
Originally written by Andor Kesselman for the TechArch repo (https://github.com/trustoverip/TechArch/blob/main/CONTRIBUTING.md)