diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf82dfc4..cfcd3681 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,4 +12,4 @@ You want to help to build and improve the *DbToolsBundle*? Here is want you can * 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) -**You will find more information in the [contribute section of our documentation](https://dbtoolsbundle.readthedocs.io/en/stable/contribute/contribute.html).** \ No newline at end of file +**You will find more information in the [contribute section of our documentation](https://dbtoolsbundle.readthedocs.io/en/stable/contribute/contribute.html).** diff --git a/docs/content/contribute/contribute.md b/docs/content/contribute/contribute.md index b54cf6cb..2394f8d3 100644 --- a/docs/content/contribute/contribute.md +++ b/docs/content/contribute/contribute.md @@ -2,10 +2,68 @@ 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 +* 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 (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) \ No newline at end of file +* 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 PRs which are not relative to an existing issue (as long as it complies with the previous rule). + +But we encourage you not do it. Proposing a PR without discussing the problem/feature with maintainers can +lead to useless work. + +### Split your contributions + +It is much easier for maintainers to review small PRs that solve one and only one issue. + +- Do not correct multiple issues in the same ticket (unless discussed and approved in advance). +- 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. + +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 maintainers! + +### Ok for AI, but in good intelligence + +While we are no big fans of AI, we accept our contributors to use it. + +**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 vibe-coded PRs. +- A PR that does not appear to have been properly reviewed by its _own_ author after using AI will be closed.