Skip to content

Latest commit

 

History

History
37 lines (19 loc) · 1.95 KB

CONTRIBUTION.md

File metadata and controls

37 lines (19 loc) · 1.95 KB

Contributing to Tech Writing Tools

Thanks for considering contributing to the tech writing tools repository. While I've been collecting these resources for a number of talks in 2019, this can become so much better when influenced by other writers.

Why should you follow these guidelines?

By reading these guidelines, I know that you're respecting my work and the work of any other writer/developer who contributes to this repository. If I come back and ask for changes or try and address the issue, know I'm coming from a good place because I want this to be the best resource it can be!

What contributions are welcome?

If you want to add to any of the tools list with resources you've found helpful, that's great. If you think that the templates can be better or are missing information, please submit changes.

Are sections missing? Create an issue and feel free to submit a new PR.

Ground rules and expectations

By working on this project, I expect you'll follow these rules:

Communication

Be respectful, considerate, and kind to others. Always assume the best of intentions, unless proven otherwise.

Technical responsibilities

Make sure you've tested before creating a PR. Broken links and styling issues can be frustrating.

Your first contribution

Working on your first pull request? Read the GitHub guide to pull requests.

Review process

Once your PR is submitted, your changes will be reviewed and constructive feedback may be given. Feedback is meant to ensure the highest quality content makes it into this project, and changes will be approved once feedback has been addressed.

Questions

Have any questions? Open an issue or tweet me at @heyawhite.