Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (21 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.3 KB

Contributing to Bash-Oneliners

👍🎉 First off, thanks for taking the time to contribute! 🎉👍 The following is a set of guidelines for contributing to this project on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Documentation Guidelines

  • Add short description of what the command does followed by the code block.
  • If you are adding a new section, then make sure to update Table of Contents.
  • Refrain from making unnecessary newlines or whitespace.
  • Use pure markdown as much as possible, html is accepted but shouldn't be a priority.
  • Last but not the least, use proper intendation.
  • The markdown must pass RemarkLint checks.

Pull Request Guidelines

  • Add succint description in the pull request and commit titles.
  • Add a section in the document if needed.
    • Add a section description.
    • Add the section title to Table of Contents.
    • Sections must be organised in alphabetical order.
  • Ensure content added to the document is not a duplicate.
    • Check open pull requests and issues to avoid duplicate entries.
  • Check for spelling and grammar issues in the document.
  • Remove any trailing whitespaces in the document.
  • Make sure the suggested command is tested and works as expected.