Feature contributors file #587
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
Sections setup real quick while I had 10 min.
Finished fleshing out Contributors.md rough draft. Will post as draft PR and look for comments.
m00sey
reviewed
Oct 17, 2023
m00sey
requested changes
Oct 17, 2023
Contributors.md
Outdated
| [PythonStyleGuide](./ref/PythonStyleGuide.md) | ||
|
|
||
| ### Commit Message Guidelines | ||
| There are no hard and fast guidelines (TODO: is this true?) but it is helpful to: |
There was a problem hiding this comment.
I mean we don't have rules, but a descriptive to the point message is ideal.
"Adds selective disclosure mechanism"
"Updates test coverage for coring"
We should discuss if we want to start requiring sign off.
|
Thanks for the PR! |
Oh whoops, yeah probably a good call. I will rename. |
Renamed file to be more appropriate to its purpose. Updated Code of Conduct section with what's in Discord. Changed Discord link. Added point to commit message section.
|
@m00sey renamed and addressed your points. Def wanted changes and input from everyone else to provide clarity which is why its in Draft form. Hopefully, we can discuss it tomorrow. |
Removed reference to git flow. Also reworded a bit of that section.
m00sey
requested changes
Oct 19, 2023
Contributing.md
Outdated
|
|
||
| ## Introduction | ||
|
|
||
| Welcome to keripy's contribution guide! This project aims to develop a reference implementation of the keri standards and protocols developed in WebOfTrust on github. We deeply appreciate the time and effort of contributors like you! |
|
@SmithSamuelM recommendation from 10/19/2023 Dev Meeting to move the licensing section to the top (I suggest under Introduction) |
Moved LICENSE reference to top of file and referenced the ietf-keri LICENSE.md for clarity. Capitalized some KERI acronyms.
m00sey
approved these changes
Oct 26, 2023
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.
Rough draft of potential CONTRIBUTORS.md file for discussion/review.