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

R4R: Contributing Guidelines advocate early discussion b4 coding #1796

Merged
merged 4 commits into from
Jul 23, 2018

Conversation

rigelrozanski
Copy link
Contributor

Based on this PR #1792 which was opened before adequate discussion had taken place, unfortunately the contributing docs didn't indicate a procedure which includes discussion in an issue before coding

  • Updated all relevant documentation (docs/)
  • [n/a] Updated all relevant code comments
  • [n/a] Wrote tests
  • [n/a] Added entries in PENDING.md
  • [n/a] Updated cmd/gaia and examples/

For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@rigelrozanski rigelrozanski added T:Docs Changes and features related to documentation. non-breaking labels Jul 23, 2018
Copy link
Contributor

@ValarDragon ValarDragon left a comment

Choose a reason for hiding this comment

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

The numbered list is a great idea as well! It's way easier to follow that.

* [ ] Wrote tests
* [ ] Added entries in `PENDING.md`
* [ ] Updated `cmd/gaia` and `examples/`
- [ ] Linked to github-issue with discussion and and accepted design
Copy link
Contributor

Choose a reason for hiding this comment

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

extra and

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed

@codecov
Copy link

codecov bot commented Jul 23, 2018

Codecov Report

Merging #1796 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1796   +/-   ##
========================================
  Coverage    63.46%   63.46%           
========================================
  Files          117      117           
  Lines         6914     6914           
========================================
  Hits          4388     4388           
  Misses        2270     2270           
  Partials       256      256

Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

This looks good, but it's starting to get rather long - maybe worth adding a "tl;dr" summary?

@rigelrozanski rigelrozanski merged commit 63f70cb into develop Jul 23, 2018
@rigelrozanski rigelrozanski deleted the rigel/contributing branch July 23, 2018 18:54
@rigelrozanski
Copy link
Contributor Author

Thinking about this more... it might be best to do something like delete all the other sections besides the first section and include links to those sections in the first sections (this sections would likely go into tendermint/coding)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants