Adding Guidance Documentation for Contributors#18
Open
izzymsft wants to merge 5 commits intopydantic:mainfrom
Open
Adding Guidance Documentation for Contributors#18izzymsft wants to merge 5 commits intopydantic:mainfrom
izzymsft wants to merge 5 commits intopydantic:mainfrom
Conversation
This satisfies pydantic#16 new file: CONTRIBUTORS.md
Contributor
Author
|
@Kludex when you have a moment, could you take a look? Thanks |
There was a problem hiding this comment.
Pull Request Overview
Adds a CONTRIBUTORS.md file to provide guidance for external contributors, covering areas of contribution, setup steps, and required checks before submitting pull requests.
- Introduces sections on contribution areas and best practices
- Details pre-commit setup, linting, and testing commands
- Includes links to project resources and communication channels
Comments suppressed due to low confidence (3)
CONTRIBUTORS.md:24
- Use triple backticks for fenced code blocks instead of four; change
bash tobash.
````bash
CONTRIBUTORS.md:34
- [nitpick] Remove "etc" for clarity and adjust heading to something like "### Running Linters and Tests".
### Running Lints and Tests etc
CONTRIBUTORS.md:43
- Use triple backticks for this fenced code block as well; change to ```bash.
````bash
CONTRIBUTORS.md
Outdated
| - python code updates (adding functionality, fixing bugs, adding code documentation etc.) | ||
| - writing new unit tests, fixing existing unit tests | ||
| - reporting issues | ||
| - making suggestions for feature requestions and improvements |
There was a problem hiding this comment.
Spelling typo: "requestions" should be corrected to "requests".
Suggested change
| - making suggestions for feature requestions and improvements | |
| - making suggestions for feature requests and improvements |
Contributor
Author
There was a problem hiding this comment.
Thanks this will be fixed shortly
CONTRIBUTORS.md
Outdated
| Your PR may not be accepted if it fails these checks. | ||
|
|
||
| It is usually a good idea to keep the branch in your fork up-to-date with the upstream branch if you are planning | ||
| to work on your changes over an extended period of time. |
There was a problem hiding this comment.
There are two spaces between "work on"—reduce to a single space.
Suggested change
| to work on your changes over an extended period of time. | |
| to work on your changes over an extended period of time. |
Contributor
Author
Contributor
Author
|
@Kludex the changes have been pushed. |
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
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.
This satisfies #16
new file: CONTRIBUTORS.md