Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.88 KB

contributing.md

File metadata and controls

44 lines (31 loc) · 1.88 KB

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:

  • Search previous suggestions before making a new one, as yours may be a duplicate.

  • Suggested command should be related to Bash Shell Scripting only.

  • Make an individual pull request for each suggestion.

  • Make sure that your command was tested before.

  • Additions should be added to the bottom of the relevant category.

  • Keep the title and description short and simple, but at the same time descriptive.

  • Use the following Markdown format:

    ### Category

#### Command title...

Command description... (optional)

```sh
# bash command...
```

_credits: [the author or source](URL)_ (optional)

  • The credits: ... sould be in italic with author or source url (this is optional).

  • Don't mention bash, shell, sh or scripting in the title or description as it's implied.

  • Start the description with a capital and end with a full stop/period.

  • The pull request should have a useful title and include the output or relevant screenshots of your command results and why it should be included.

  • Check your spelling and grammar.

  • Make sure your text editor is set to remove trailing whitespace.

  • New categories, or improvements to the existing categorization are welcome.

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. 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.