Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).**
**You will find more information in the [contribute section of our documentation](https://dbtoolsbundle.readthedocs.io/en/stable/contribute/contribute.html).**
64 changes: 61 additions & 3 deletions docs/content/contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
* 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_
Comment thread
SimonMellerin marked this conversation as resolved.
Outdated

### 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).
Comment thread
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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
But we encourage you not do it. Proposing a PR without discussing the problem/the feature with maintainers can
But we encourage you to not do it. Proposing a PR without discussing the problem/feature with maintainers can

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no sure about this to to add, I removed the second the

lead to useless work.

### Split your contributions

It is much easier for mainteners to review small PRs that solve one and only one issue.
Comment thread
SimonMellerin marked this conversation as resolved.
Outdated

- 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 mainteners!
Comment thread
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.
Comment thread
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.