Add to the handbook
Contributing to the handbook
Contributions from the team are always welcome! This handbook is currently in alpha, meaning we’re testing out what content and guidance is useful. Raising issues and pull requests is strongly encouraged, so that we can develop the handbook as a team.
We continually update this handbook because we’re always looking for better ways to get things done. And that changes over time, especially as who works on the team and what we work on changes too.
This document is a guide on contributing to the handbook. It is a live guide and may not be complete, so you can raise problems or queries with a delivery manager, product manager or service owner.
Who can contribute
Contributions must come from people on the Planning Data team. They are the users of this handbook and the subject matter experts.
What to contribute
This handbook is for you. It’s a reference, a set of docs to turn to when you’re unsure about something, so contribute anything that will help you in your day job.
Step-by-step guides on how to do things and our processes are good. Models, principles, ways of thinking and examples are great. It helps us learn what we do, and how and why we do it.
How to contribute
How you contribute will depend on your familiarity with working on GitHub, but contributing to the handbook is a safe way to build your skills.
1. Using a text editor
Most people are familiar with text editors like Notepad, Google Docs, Microsoft Word or Notion. You can use whatever is most familiar to you to make a contribution.
Write your contribution and share the document with someone on the team for feedback.
When your document is ready to be published, seek help from a developer or designer to raise a pull request.
2. Using the GitHub file editor
You can create and edit files using the GitHub file editor. Most files can be found in their corresponding folder inside the /docs/ folder. For example, files describing our support processes can be found in /source/support folder.
You can follow GitHub’s detailed guides on creating new files and editing files to create or edit a file.
3. Using your machine
If you choose this option, you probably know how to do it. Create a branch, commit changes and raise a pull request. Your pull request will be reviewed and approved when ready. You can merge your pull request once approved.
4. Create an issue
You can also create an issue to suggest additions and changes without working directly on the files. Add a new issue via the Issues view to suggest documentation for the handbook.
Need help?
Ask your team-mates in the team Slack channel, someone will reply and help out.