Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 2.69 KB

CONTRIBUTION GUIDELINES

Before contributing

Welcome to Books Doc! Before submitting pull requests, please make sure that you have read the whole guidelines. If you have any doubts about this contribution guide, please open an issue.

Contributing

Contributor

Being a contributor at The World-org, we request you to follow the points mentioned below:

  • You did a new work.
    • No duplication allowed. This work will not be merged.
  • Please follow the repository guidelines and standards mentioned below.

New implementation New implementations are welcome!

Making Changes

Documentation

  • Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure. If you want to create a new directory, then please check if a similar category has been recently suggested or created by other pull requests.
  • If you have modified/added documentation, please ensure that your language is concise and must not contain grammatical errors.
  • Do not update README.md along with other changes. First, create an issue and then link to that issue in your pull request to suggest specific changes required to README.md.

New Directory guidelines

  • We recommend adding files to existing directories as much as possible.
  • Use lowercase words with spaces as separator ( no "_" or "-" allowed ) for directories.
  • For instance
SomeNew Fancy-Category          is incorrect
Some New Fancy Category         is correct

New File Names guidelines

  • We recommend adding files to existing directories as much as possible.
  • Use lowercase words with "_" as separator ( no "-" allowed ) for files
  • For instance
SomeNew Fancy-Category          is incorrect
some_new_fancy_category         is correct

Commit Guidelines

  • Try to modify just one file in the same directory. Pull requests that span multiple directories are often rejected.

When fixing an issue -

git checkout -b <issue number>
git add file_xyz.cpp
git commit -m "your message"

Common prefixes:

  • fix: A bug fix
  • feat: A new feature
  • docs: Documentation changes
  • website: Improvement in website content

Pull Requests

Happy contributing!❤️