Added CODESYTLE.md #21
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
…nto add-codestyle
|
Do take note that there are plans to migrate documentation to either a 3rd party like readthedocs, or a 1st party self-hosted solution. I will make a discussion thread soon, so please do partake. I'd love to hear your opinion! |
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.
What type of PR is this? (check all applicable)
Description
When I was committing changes to my fork, I realized that there was a drastic difference between how I write my commit messages compared to yours. As a result I tried rebasing those messages and well...
After that little incident, I realized that it might be beneficial to have a
CODESTYLE.mdfile, not just for me, but possibly for other contributors as your project grows. I tried my best to replicate your preferences in this document, but there might be things that I am missing or concepts that I am not aware of. So feel free to edit/request changes to your liking!Caution
I accidentally committed
add build instructions, this was meant for another branch. Due to lack of knowledge, I just removed it from this commit. There are also two merges present, I don't think they should affect anything but I encourage making sure it's ok.Added/updated tests?
We encourage you to keep the code coverage percentage at 80% and above.
Checklist