Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.72 KB

contributing.md

File metadata and controls

23 lines (12 loc) · 1.72 KB

Contributing

Issues

We use Linear to track issues - to access it, sign in with your @ystv.co.uk Google account (ask a Computing Team member if you don't have one).

File an issue for any significant change you plan to make, particularly if it was requested by someone outside of Computing Team (in this case, please add the User Feedback label).

If you're planning to work on something, please assign it to yourself on Linear. If you need to stop work, or you find it's too complicated, un-assign it (and leave a comment summarising your progress so far).

Feel free to assign any un-assigned issue to yourself, you don't need to ask anyone. But if the issue is assigned to someone else, ask them before you start work on it.

Branch Names

Branches created for Linear issues should use the branch name provided by linear which follow the format int-<issue id>-<issue title>. Branches unrelated to a filed issue should be in the format <initials or first name>/<feature or fix being implemented>, for example mia/fix-main-again.

Commits

Commit messages can contain a related Linear issue ID (in the format [INT-\<ID>]) at the beginning to help Linear track issue progress, however this is not enforced or widely used.

Pull requests

Pull requests related to an issue should contain the Linear issue ID and either the issue title, or a summary of what was done to close the issue. For example: [INT-67] Add Dark Mode. This helps Linear to track what stage the issue is in and should be followed for all issues where applicable.