From 60646bcadb9989e894b91de31e431d25581fef17 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Fri, 26 Mar 2021 20:20:50 +0100 Subject: [PATCH] Improve CONTRIBUTING.md (#129) --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10817a5..28da5b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,15 +5,16 @@ We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/comm ## Issue tracker Whether you are looking for an opportunity to contribute or you found a bug and already know how to solve it, please go to the [issue tracker](https://github.com/ansible-collections/community.mysql/issues). -There you can find feature ideas to implement, reports about bugs to solve, or submit an issue to discuss your idea before implementing it which can help choose a right direction initially and potentially save a lot of time and effort. +There you can find feature ideas to implement, reports about bugs to solve, or submit an issue to discuss your idea before implementing it which can help choose a right direction at the beginning of your work and potentially save a lot of time and effort. Also somebody may already have started discussing or working on implementing the same or a similar idea, so you can cooperate to create a better solution together. ## Open pull requests Look through currently [open pull requests](https://github.com/ansible-collections/community.mysql/pulls). -You can help by reviewing them. Reviews help move pull requests to merge state. Some good pull requests cannot be merged only due to a lack of reviews. Also, consider taking up a valuable, reviewed, but abandoned pull request which you could politely ask the original authors to complete yourself. -And it is always worth saying that good reviews are often more valuable than pull requests themselves. +You can help by reviewing them. Reviews help move pull requests to merge state. Some good pull requests cannot be merged only due to a lack of reviews. And it is always worth saying that good reviews are often more valuable than pull requests themselves. + +Also, consider taking up a valuable, reviewed, but abandoned pull request which you could politely ask the original authors to complete yourself. ## Discussions @@ -25,6 +26,7 @@ First, see the paragraphs above. If you came up with a new feature, it is always worth creating an issue before starting to write code to discuss the idea with the community first. +If you are going to implement the feature yourself, say it in the issue explicitly to avoid working in parallel with somebody else. ## Step-by-step guide how to get into development quickly