[improvement] updated contribution guidelines #945
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kvedala
commented
Jul 9, 2020
| @@ -28,8 +28,85 @@ We are very happy that you consider implementing algorithms and data structures | |||
| - Strictly use snake_case (underscore_separated) in filenames. | |||
| - If you have added or modified code, please make sure the code compiles before submitting. | |||
| - Our automated testing runs [__cpplint__](https://github.com/cpplint/cpplint) on all pull requests so please be sure that your code passes before submitting. | |||
| - Please conform to [doxygen](https://www.doxygen.nl/manual/docblocks.html) standard and document the code as much as possible. This not only facilitates the readers but also generates the correct info on website. | |||
There was a problem hiding this comment.
The redundancy is deliberate to ensure contributors do notice it.
ayaankhan98
approved these changes
Jul 9, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Change
Contribution guidelines updated with increased standards specs
Provides a sample code structure for reference
Checklist
[ ] Added file name matches File name guidelines[ ] Added tests and example, test must pass[ ] Added documentation so that the program is self-explanatory and educational - Doxygen guidelinesNotes: