Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md #470

Merged
merged 3 commits into from
Jul 22, 2020
Merged

Add CONTRIBUTING.md #470

merged 3 commits into from
Jul 22, 2020

Conversation

brapse
Copy link
Contributor

@brapse brapse commented Jul 22, 2020

Provide an initial CONTRIBUTING.md

Missing several key sections but hoping this can get us started.

Closes #323

  • Referenced an issue explaining the need for the change
  • Updated all relevant documentation in docs
  • Updated all code comments where relevant
  • Wrote tests
  • Updated CHANGES.md

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
Issue. The issue helps capture the problem you're trying to solve and allows for
early feedback. Once the issue is created, maintainers may request more detailed
documentation be written in the form of a Request for Comment (RFC) or
Architectural Decision Record (ADR).
Copy link
Member

@liamsi liamsi Jul 22, 2020

Choose a reason for hiding this comment

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

Maybe link to https://github.com/informalsystems/tendermint-rs/blob/master/docs/architecture/README.md (?)
Not sure if there is an RFC equivalent (I do not think so).

When the problem is well understood but the solution leads to large
structural changes to the code base, these changes should be proposed in
the form of an [Architectural Decision Record
(ADR)](./docs/architecture/). The ADR will help build consensus on an
Copy link
Member

@liamsi liamsi Jul 22, 2020

Choose a reason for hiding this comment

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

Ah OK 👌 Still valuable to link to the ADR readme above I think.

CONTRIBUTING.md Outdated
- [module] \#xxx Some description about the change (@contributor)
```
Here, `module` is the part of the code that changed (typically a
top-level package), `xxx` is the pull-request number, and `contributor`
Copy link
Member

Choose a reason for hiding this comment

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

Is package a relict from go-land? The top-level dirs here represent crates. One level below it's usually modules.

CONTRIBUTING.md Outdated
Note this means pull-requests should be opened first so the changelog can then
be updated with the pull-request's number.
There is no need to include the full link, as this will be added
automatically during release. But please include the backslash and pound, eg. `\#2313`.
Copy link
Member

Choose a reason for hiding this comment

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

as this will be added automatically during release

That is not the case (yet). In tendermint go there is a python script which does this. Not here.

brapse and others added 2 commits July 22, 2020 16:31
Co-authored-by: Ismail Khoffi <Ismail.Khoffi@gmail.com>
Copy link
Member

@liamsi liamsi left a comment

Choose a reason for hiding this comment

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

Awesome! And thanks for taking this over 👍

@liamsi liamsi merged commit 6fe1eda into master Jul 22, 2020
@liamsi liamsi deleted the brapse/initial-contributing-2 branch July 22, 2020 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md
2 participants