Move coding conventions to wiki #35
Merged
Conversation
This file contains hidden or 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
Remove the coding conventions section from the Contributing file and move them to the project wiki.
hctrdev
changed the title
ilusi0n
previously approved these changes
Jun 14, 2020
ColmBhandal
reviewed
Jun 15, 2020
CONTRIBUTING.md
Outdated
| | Variable Naming | As far as possible, variables should be named so that the meaning of the variable can be inferred from the variable. name. You can always start coding with variables like `i` and `j` and then when it's time to commit your code, you can use your IDE to rename the variables to something more descriptive e.g. `rowIndex` and `columnIndex`.| | ||
|
|
||
| ...More conventions will follow. Please be patient with us as we convert our coding experience to text... | ||
| You can find the latest coding conventions in the [wiki](https://github.com/ColmBhandal/CsharpExtras/wiki/Coding-Conventions). |
Owner
There was a problem hiding this comment.
I would say something stronger here. E.g.
As part of our contributing guidelines, we recommend you check out our coding conventions. This will help streamline our process as we will be less likely to require minor changes on pull requests. Please check out the changes on our Wiki if this is your first time contributing to the repo: [LINK]
Update the Contributing file with stronger wording around where to find the coding conventions.
ColmBhandal
approved these changes
Jun 15, 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
Remove the coding conventions section from the Contributing file and move them to the project wiki.