Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.67 KB

contributing.md

File metadata and controls

34 lines (26 loc) · 1.67 KB
Raw

Contribution Guidelines

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

Ensure your pull request adheres to the following guidelines:

  • Use the following format: resource-name - Description.
  • Only use the official english brand name TU Wien or the abbreviation TUW as stated in the corporate design.
  • Make an individual pull request for each suggestion.
  • Additions should be added to the bottom of the relevant category.
  • Link to the GitHub repo, not a package manager description.
  • Keep descriptions short and simple, but descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Don't start the description with A or An.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request should have a useful title and include an explanation why it should be included.
  • New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request.

Thank you for your suggestions!

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.