Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.6 KB

contributing.md

File metadata and controls

33 lines (23 loc) · 1.6 KB

Contribution Guidelines

Note

This project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

What to contribute

Anything that makes this project better is welcome.

  • Add a new category.
  • Add a new resource.
  • Update an exsiting resource.
  • Remove an obsolete resource.
  • Correct or imporve descriptions.
  • Other improvements that haven't come to my mind.

How to contribute

Tip

A Github account is required for contributing to this project. If you haven't got one, create your first Guthub account right now.

  1. Open the Awesome Technical Writing Learning on Github.
  2. Click the file you want to improve, e.g. README.md.
  3. Click the pencil icon on the top-right corner of the panel.
  4. Edit the file text in the in-browser editor using Github Flavored Markdown.
  5. Tell us why the changes can improve the file or the project by filling the Propose file change form.
  6. Click the Propose file change button to submit the pull request.

How to update your pull request

If project maintainers notice anything that they like to change, they will ask you to edit your pull request before merging it.

In these cases, there is no need to open a new pull request, just edit the existing one.