Skip to content

Latest commit

 

History

History
42 lines (23 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

42 lines (23 loc) · 2.15 KB

Contributing

If you have an idea you'd like to contribute please log an issue.

If you'd like to suggest a change, contributions should be submitted via a pull request.

If you have any questions or need to discuss or check anything contact us via the #dst-guides channel in Slack.

What not to include

  • Deployment guides or details
  • Details of infrastructure
  • Details about any service's back office processes
  • Personal contact information

If in doubt speak to Alan Cruikshanks or Ben Sagar before creating the PR.

Getting started

Create a branch. Use a brief but descriptive name and try and avoid spaces and capitilisation for example add-more-details-for-contributors.

Start committing your changes and push straight away rather than when finished.

When you're finished

Make sure everything is pushed, then add the ready for review label to the PR and ensure you are assigned. Announce your PR in the #development channel in Slack.

Getting feedback

Feedback will be provided within the PR. Decisions will be documented and reasons given.

We want to encourage all to contribute and suggest ways we can improve. Anyone providing feedback should be positive and professional with any comments made about your contribution, but let us know if you feel we failed.

We don't expect everyone to be available or able to contribute but we want to allow enough time for those who wish to get involved. Don't merge your PR for at least 3 days, even if you've had lots of positive feedback.

Finishing up

Leave the PR open for at least 3 working days and ensure at least one other person has reviewed it.

Once those who have participated in the PR have said they are happy, first squash your commits down to a single commit. Then merge it in GitHub (not locally). Don't forget to also delete the branch in GitHub. You can do all this from the GitHub web interface.

Sit back, have a 🍹, and ponder your next contribution!