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

Update contributing guidelines #2563

Merged
merged 2 commits into from Feb 19, 2019
Merged

Conversation

yeastplume
Copy link
Member

Will give a couple of days for reviews or suggestions before merging

@lehnberg
Copy link
Collaborator

Does it make sense to also include specific instructions to update any documentation that is affected by the PR in question?

@JeremyRubin
Copy link
Contributor

I think that you could make pull_request_template.md with sections for:

* Includes a proper description of what problems the PR addresses, as well as a detailed explanation as to what it changes
* Explains whether/how the change is consensus breaking or breaks existing client functionality
* Contains unit tests exercising new/changed functionality
* Fully considers the potential impact of the change on other parts of the system
* Describes how you've tested the change (e.g. against Floonet, etc)

which might be a bit friendlier for first time contributors.

Copy link
Contributor

@ignopeverell ignopeverell left a comment

Choose a reason for hiding this comment

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

I think @JeremyRubin PR template makes sense as well.

@yeastplume yeastplume merged commit b1c0994 into mimblewimble:master Feb 19, 2019
@yeastplume yeastplume deleted the contributing branch March 4, 2019 10:04
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.

None yet

4 participants