-
Notifications
You must be signed in to change notification settings - Fork 16
docs: Add contribution rules #250
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a5c93c1
docs: Add contribution rules
SimonMellerin 5c3495c
docs: Add contribution rules
SimonMellerin 2c3fe90
docs: Add contribution rules
SimonMellerin 549e755
docs: Add contribution rules
SimonMellerin a0e7b25
docs: Add contribution rules
SimonMellerin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,9 +3,67 @@ | |||||
| You want to help to build and improve *DbToolsBundle*? Here is want you can do: | ||||||
|
|
||||||
| * Talk about it: share this bundle to make it more visible | ||||||
| * Help us with this documentation, you have seen a typo? something is missing? [Issues](https://github.com/makinacorpus/DbToolsBundle/issues) & PRs are welcome | ||||||
| * Help us with this documentation, you have seen a typo? something is missing? [Issues](https://github.com/makinacorpus/DbToolsBundle/issues) & PRs are welcome (but before, please, take look at our contribution rules below) | ||||||
| * Report bugs you find: [Reporting issues](https://github.com/makinacorpus/DbToolsBundle/issues) is essential to help us improve this tool. | ||||||
| Feel confident enough to correct it? PRs are welcome! | ||||||
| * Want to add more Anonymizers? [Why not distribute your own pack](./pack)? | ||||||
| * Want to add missing functionnality? Create an [issue](https://github.com/makinacorpus/DbToolsBundle/issues)! | ||||||
| * Want to start developing ? Look at ["good first issues"](https://github.com/makinacorpus/DbToolsBundle/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | ||||||
| * Want to start developing ? Look at ["good first issues"](https://github.com/makinacorpus/DbToolsBundle/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | ||||||
|
|
||||||
| ## Contribution rules | ||||||
|
|
||||||
| While we want DbToolsBundle to be a community project, **we do not accept any kind of contribution**. | ||||||
|
|
||||||
| We ask our contributors to follow these simple rules: | ||||||
|
|
||||||
| ### Basic courtesy | ||||||
|
|
||||||
| Each issue and PR must be introduced with a clear description that expose the problem it solves or the feature | ||||||
| it implements. | ||||||
|
|
||||||
| _Each wild PR that does not comply with this rule won't be read_ | ||||||
|
|
||||||
| ### PR without associated issue | ||||||
|
|
||||||
| Note that we accept PR which are not relative to an existing issue (as long as it complies with the previous rule). | ||||||
|
SimonMellerin marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| But we encourage you not do it. Proposing a PR without discussing the problem/the feature with maintainers can | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. no sure about this |
||||||
| lead to useless work. | ||||||
|
|
||||||
| ### Split your contributions | ||||||
|
|
||||||
| It is much easier for mainteners to review small PRs that solve one and only one issue. | ||||||
|
SimonMellerin marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| - Do not correct multiple issues in the same ticket (unless discussed and approved in advance) | ||||||
|
SimonMellerin marked this conversation as resolved.
Outdated
|
||||||
| - Do not make changes that are too invasive or too large (unless discussed and approved in advance) | ||||||
|
|
||||||
| ### Mind the documentation | ||||||
|
|
||||||
| We care a lot about documentation and changelog. | ||||||
|
|
||||||
| We consider that a feature which is not documented does not exist. So if you add a new | ||||||
| feature, document it in the correct section of our documentation. | ||||||
|
|
||||||
| Whether you are fixing a bug or developing a new feature : mention it in the `CHANGELOG.md` file. | ||||||
|
SimonMellerin marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| This file already contains a lot of content, you should quickly understand the expected syntax. | ||||||
|
|
||||||
| ### Ask for help | ||||||
|
|
||||||
| If you encounter problem while contributing, we encourage you to ask us for help. | ||||||
|
|
||||||
| Don't hesitate to push draft PRs and to ping mainteners! | ||||||
|
SimonMellerin marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| ### Ok for AI, but in good intelligence | ||||||
|
|
||||||
| While we are no big fan of AI, we accept our contributor to use it. | ||||||
|
SimonMellerin marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| **But** | ||||||
|
|
||||||
| Your use of AI should not cost to us. AI is just a tool to produce code, it is your responsability to ensure that | ||||||
| the produced code complies with all the previous rules. | ||||||
|
|
||||||
| This being said: | ||||||
|
|
||||||
| - We won't accept completely vide-coded PRs | ||||||
| - A PR that does not appear to have been properly reviewed by its own author after using AI will be closed | ||||||
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.
Uh oh!
There was an error while loading. Please reload this page.