Javascript: Is there CONTRIBUTING.md

Created on 13 Feb 2017 · 6Comments · Source: airbnb/javascript

I made PR #1295 and you overwrote my commit message. I think we need a rule for commit message to avoid overwriting commit messages. If there is the rule, it could be good for contributors. For example, we need create the rule like below:

[Tests] ~ for test
[eslint config] ~ for eslint rule
[guide][react] ~ for gude ?

What do you think ?

Source

sotayamashita

Most helpful comment

@ljharb

it's always acceptable and expected for maintainers to edit commit messages, rebase, squash, etc, upon merging - neither the original commit message nor commit authorship should be expected to be retained (although authorship generally is, out of courtesy)

I understand the necessity of maintainers to edit.

I'd be fine with a PR that documented our commit messages (we'd probably need some back-and-forth on the PR before it was final), although this is the first time it's really come up.

In Airbnb, Is there a rule of commit message ? if it is, I think we can create new one based on existing rule.

sotayamashita on 13 Feb 2017

👍2

All 6 comments

A few points:

it's always acceptable and expected for maintainers to edit commit messages, rebase, squash, etc, upon merging - neither the original commit message nor commit authorship should be expected to be retained (although authorship generally is, out of courtesy)
The existing git log should indicate the conventions that are used.
I'd be fine with a PR that documented our commit messages (we'd probably need some back-and-forth on the PR before it was final), although this is the first time it's really come up.

ljharb on 13 Feb 2017