docs: update CONTRIBUTING.md and PR template
#217
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
iajoiner
force-pushed
the
docs/new-intro
branch
from
7da8287
to
0530120
Compare
JayWhite2357
reviewed
Oct 4, 2024
JayWhite2357
reviewed
Oct 5, 2024
|
Overall I think the PR template needs to be updated to include the commands to run the CI check script once we merge #208 so that its front and center in case people ignore the contributing docs. Further, that PR template should have a small example of how we want the PR description to look so people can easily work off of that. This should greatly clarify our expectations and decrease turn around time during reviews |
Dustin-Ray
reviewed
Oct 5, 2024
iajoiner
force-pushed
the
docs/new-intro
branch
from
f1aedfa
to
8dbd581
Compare
iajoiner
force-pushed
the
docs/new-intro
branch
3 times, most recently
from
c890dd7
to
5f8a6ad
Compare
|
@Dustin-Ray @JayWhite2357 Please review again. |
iajoiner
changed the title
CONTRIBUTING.mdCONTRIBUTING.md and PR template
iajoiner
force-pushed
the
docs/new-intro
branch
from
5f8a6ad
to
141f451
Compare
iajoiner
force-pushed
the
docs/new-intro
branch
2 times, most recently
from
6620d28
to
1f6ac54
Compare
iajoiner
force-pushed
the
docs/new-intro
branch
from
1f6ac54
to
cb27184
Compare
iajoiner
force-pushed
the
docs/new-intro
branch
from
cb27184
to
0fff4b0
Compare
Dustin-Ray
approved these changes
Oct 7, 2024
|
🎉 This PR is included in version 0.28.5 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
Rationale for this change
CONTRIBUTING.mdis seriously out of date now that we are an open source project. Furthermore the PR template needs an example so that we can set adequate expectations for contribution.What changes are included in this PR?
cargo testcommandGetting Startedwith Rust installation and repo forking guideCONTRIBUTING.mdand add an exampleAre these changes tested?
N/A since there are no code changes.