Patch #31327

Update CONTRIBUTING.md

Added by Go MAEDA 2 months ago. Updated 2 months ago.

Status:ClosedStart date:
Priority:NormalDue date:
Assignee:Go MAEDA% Done:

0%

Category:Documentation
Target version:4.1.0

Description

I feel that the sentence "Do not send a pull request to this GitHub repository" in CONTRIBUTING.md (source:tags/4.0.3/CONTRIBUTING.md) is a bit harsh. I want to soften the tone to reduce the psychological hurdle of contributing.

Here is my idea of new CONTRIBUTING.md. Feedbacks welcome.

CONTRIBUTING.md (519 Bytes) Go MAEDA, 2019-05-09 06:26

CONTRIBUTING.md (494 Bytes) Jan from Planio www.plan.io, 2019-05-09 12:57

Associated revisions

Revision 18151
Added by Go MAEDA 2 months ago

Update CONTRIBUTING.md (#31327).

We should always be polite :-)

Revision 18155
Added by Go MAEDA 2 months ago

Fix typo: s/web site/website/ (#31327).

History

#1 Updated by Bernhard Rohloff 2 months ago

You're absolutely right. Your wording sounds much more polite and also gives a sane reason for it.

#2 Updated by Go MAEDA 2 months ago

Bernhard Rohloff wrote:

You're absolutely right. Your wording sounds much more polite and also gives a sane reason for it.

Thank you for the feedback. I am not good at English, so please don't hesitate to point out any mistakes in grammar or wording.

#3 Updated by Jan from Planio www.plan.io 2 months ago

I am for this change and I've reworded the 2nd sentence a bit. I think we can say that PRs might not even get reviewed at all without being impolite here.

@@ -1,8 +1,8 @@
-Please **open an issue on the [official website]** instead of sending pull-requests.
+Please **open an issue on the [official website]** instead of sending pull requests.

-Since the development of Redmine is conducted on not GitHub but the [official web site] and core developers rarely see the repo on GitHub, it may take a longer time for pull-requests on GitHub to be reviewed.
+Since the development of Redmine is not conducted on GitHub but on the [official web site] and core developers are not monitoring the GitHub repo, pull requests might not get reviewed.

-For more detail about how to contribute, please see the wiki page  [Contribute] on the [official website].
+For more detail about how to contribute, please see the wiki page [Contribute] on the [official website].

 [official website]: https://www.redmine.org
 [Contribute]: https://www.redmine.org/projects/redmine/wiki/Contribute

I'm attaching my version. Should we also add Your contributions to Redmine are welcome! to the beginning? :-)

#4 Updated by Go MAEDA 2 months ago

Jan from Planio www.plan.io wrote:

I am for this change and I've reworded the 2nd sentence a bit.

Thank you for fixing the sentence. It has become much better!

I'm attaching my version. Should we also add Your contributions to Redmine are welcome! to the beginning? :-)

Do you mean like the following? I like this idea.

Your contributions to Redmine are welcome!

Please **open an issue on the [official website]** instead of sending pull requests.

#5 Updated by Jan from Planio www.plan.io 2 months ago

I think that would be great, yes.

#6 Updated by Marius BALTEANU 2 months ago

Nice idea :)

#7 Updated by Go MAEDA 2 months ago

  • Status changed from New to Closed
  • Assignee set to Go MAEDA

Committed the new CONTRIBUTING.md. Thanks.

Also available in: Atom PDF