Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 2.18 KB
Raw

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.
  • New categories, or improvements to the existing categorization are welcome.
  • Keep descriptions short and simple, but descriptive.
  • End all descriptions with a full stop/period.
  • Check your spelling and grammar.

New scripts

For adding new scripts keep the code clear and concise.

If the script you're adding is under a folder, follow the format in tools/tilux/command_options.rb).

If you have a better way to call scripts, feel free to implement it.

Remember to add the new script to guide, tilux tools/tilux/print_options.rb (both to the category and help, following the format) and man/tilux.1.

Working on making adding a new command faster and better. #32

See Updating Docs to copy GUIDE.md.

New doc file

First, open up a new issue to ask if it is a good idea and helpful.

After getting a confirmation either create a .rst or .md file.

Try to keep the file clear and concise without spelling mistakes and add the file to docs/source/index.rst toctree.

Updating Docs

In the case you are updating docs/source/guide.md, docs/source/packages.md, GUIDE.md and/or PACKAGES.md. Changes must be made in GUIDE.md and/or PACKAGES.md. Applying the changes also to docs/source/ using scripts/copy_content.

With either README.md or index.rst the changes must be added manually (both files have the same content).

Make sure the docs run:

make docs

Contribution to GitHub steps

  • Fork it!
  • Create your branch: git checkout -b my-new-branch
  • Commit your changes: git commit -am 'Fixed typo'
  • Push to the branch: git push origin my-new-branch
  • Submit a pull request

Updating your Pull Request

Sometimes, a maintainer of an this list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the guidelines.