This repository has been archived by the owner on Apr 29, 2024. It is now read-only.
Flesh out CONTRIBUTING.md
#416
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
cloudhead
force-pushed
the
cloudhead/contributing
branch
from
f0dcd3f
to
6cb0725
Compare
FintanH
reviewed
Mar 13, 2023
cloudhead
force-pushed
the
cloudhead/contributing
branch
from
6cb0725
to
be7ca70
Compare
slack-coder
reviewed
Mar 13, 2023
CONTRIBUTING.md
Outdated
| * Run the tests with `cargo test --all`. | ||
| * Before adding any code dependencies, check with the maintainers if this is okay. | ||
| * Write properly formatted comments: they should be English sentences, eg: | ||
| * Follow the coding guidelines when proposing code changes (see below). |
There was a problem hiding this comment.
Maybe link to the section? (Github?) Markdown supports this. For instance:
* Follow the coding guidelines when proposing code changes ([see below](#code-style)).
CONTRIBUTING.md
Outdated
| * Before adding any code dependencies, check with the maintainers if this is okay. | ||
| * Write properly formatted comments: they should be English sentences, eg: | ||
| * Follow the coding guidelines when proposing code changes (see below). | ||
| * Write properly formatted git commits (see below). |
|
What about a note re: checking issues + proposing changes there first? Discussing the changes before putting the work in can save significant time and effort |
|
Yeah good point although I'd like to save that for when we can actually point people to |
cloudhead
force-pushed
the
cloudhead/contributing
branch
from
be7ca70
to
4d91e8b
Compare
Add code guidelines and instructions.
cloudhead
force-pushed
the
cloudhead/contributing
branch
from
4d91e8b
to
3ae037f
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add code guidelines and instructions.