awesome-osx-command-line/contributing.md
2015-11-04 13:22:02 +01:00

1.2 KiB

Contribution Guidelines

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Titles need to be capitalized properly. Don't be lazy. For help with this, see Online Capitalize Tool. Use Chicago Manual of Style rules.
  • Keep descriptions short and simple.
  • End all descriptions with a full stop/period.
  • Order titles alphabetically within each category.
  • Group commands for checking, enabling and disabling in one code block.
  • Always use code fencing with the bash descriptor.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request and commit should have a useful title.
  • New categories or improvements to the existing categorization are welcome.
  • Pull requests that are not fixed according to the comments within one week will be closed.
  • Always use folder instead of directory in titles and descriptions.

Thank you for your suggestions!