-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
Conversation
There was a problem hiding this 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.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
* [ ] Wrote tests | ||
* [ ] Added entries in `PENDING.md` | ||
* [ ] Updated `cmd/gaia` and `examples/` | ||
- [ ] Linked to github-issue with discussion and and accepted design |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extra and
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
addressed
Codecov Report
@@ Coverage Diff @@
## develop #1796 +/- ##
========================================
Coverage 63.46% 63.46%
========================================
Files 117 117
Lines 6914 6914
========================================
Hits 4388 4388
Misses 2270 2270
Partials 256 256 |
There was a problem hiding this 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?
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 |
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
docs/
)PENDING.md
cmd/gaia
andexamples/
For Admin Use: