Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

35 lines (27 loc) · 1.26 KB

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.
  • Suggested packages should be tested and documented.
  • Make an individual pull request for each suggestion.
  • Use the following format:
    ## [package](link)

    ### command

    ```
    $ git command
    What happens
    ```

NOTE: You could include a screenshot, a short description or whatever you like if:

  1. It simply makes it a lot easier for the readers to understand.
  2. It is hard to reproduce the command (EG: must follow sequences).
  3. The output of the command is not self-explanatory of what it's doing.
  4. Any other good reasons (must be written in the PR).
  • Additions should be added to the bottom of the relevant category.
  • New categories, or improvements to the existing categorization are welcome.
  • Keep descriptions short and simple, but descriptive.
  • Start the description with a capital and end with a full stop/period.
  • 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 a link to the package and why it should be included.

Thank you for your suggestions!