Skip to content

Latest commit

 

History

History
64 lines (36 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

64 lines (36 loc) · 2.26 KB

Contributing

Awesome that you are reading this 👍

  • For questions, you can create an Issue
  • Changes go via Pull Requests

Please follow the (code of conduct)[code_of_conduct.md].

Changes I'd be happy to accept:

  • Examples of correct code that is rejected, see 'My correct code is rejected, but should be accepted'
  • Examples of incorrect non-evil code that is accepted, see 'My incorrect non-evil code is accepted, but should be rejected'
  • Fixing typo's, improve layout, fix grammar, or other textual (non-code) improvements, see 'Improving text'

Changes I will reject:

  • Adding advice without references
  • Example code that does not follow the modern standard

My correct code is rejected, but should be accepted

If you think this project would improve by accepting your correct code, you can help improve it by submitting a Pull Request on the develop branch.

Your main.cpp must be put in the chapter's name folder and renamed to accept_[number].cpp, where [number] should be a number.

If your correct code is accepted, this will break this project's build.

The maintainers of this project will take a look at your code.

If the code is found correct indeed, your code will be accepted and a fix will be added.

If the code is found incorrect, your code will be rejected. Sorry :bowtie:

My incorrect non-evil code is accepted, but should be rejected

If you think this project would improve by rejecting your non-evil code, you can help improve it by submitting a Pull Request on the develop branch.

Your main.cpp must be put in the chapter's name folder and renamed to reject_[number].cpp, where [number] should be a number.

If your incorrect non-evil code is accepted, this will break this project's build.

The maintainers of this project will take a look at your code.

If the code is found non-evil indeed, your code will be accepted and a fix will be added.

If the code is found evil, your code will be rejected. Sorry :bowtie:

Improving text

As text need not be checked as thoroughly, this can be done on the master branch.

Click 'Edit' when viewing any text.

Click on 'Edit' to edit the text

Click 'Commit' when done.

If the text is found to be changed for the worse, your suggestion will be rejected. Sorry :bowtie: