...
- Join the discussion and share ideas in our Slack channel and regular TSWG and TATF meetings.
- Raise an issue or feature request in our issue tracker
- Help another contributor with one of their questions, or a documentation review
- Suggest improvements by supplying a Pull Request or opening a Discussion
- Evangelize our work together in conferences, podcasts, and social media spaces.
This guide is for you.
Table Of Contents
...
This section is designed to help you make an edit if you aren't familiar with using Github GitHub and want to make a change to the TechArch any repository.
Basic Change Flow
If you're not familiar with Github GitHub and Git, here 's are a few simple steps you can use to get going and to 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 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 Requestand choose to set the request to merge to theTechArch:mainbranch. Put any information you want to describe your changes on in the description, and you're done! Learn More.
...
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 propogate propagate to the PR.
You may want to re-request a review. Click the sync button to do so:
...
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
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
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)