Contributing.md link & PR template simplifications & Added ISSUE_TEMPLATE.md #1399

xBalbinus · 2022-05-03T18:10:58Z

Closes: #1263 (Not merging until this also gets closed on docs side)

What is the purpose of the change

There's a bunch of stuff that if in the current PR template that we can simplify and make smoother.

Brief change log

Added a link to the upcoming "contributing.md" located soon on both the docs and this current repo
Changed current PR template to be smoother (less scrolling for everyone!)

Tests / Documentation

No tests altered, documentation soon to be PR'd onto docs.

codecov-commenter · 2022-05-03T18:25:12Z

Codecov Report

Merging #1399 (0ff98ce) into main (f56fbe5) will decrease coverage by 0.29%.
The diff coverage is 17.15%.

@@            Coverage Diff             @@
##             main    #1399      +/-   ##
==========================================
- Coverage   19.82%   19.53%   -0.30%     
==========================================
  Files         202      226      +24     
  Lines       27685    30950    +3265     
==========================================
+ Hits         5489     6045     +556     
- Misses      21175    23800    +2625     
- Partials     1021     1105      +84

Impacted Files	Coverage Δ
x/epochs/client/cli/query.go	`0.00% <ø> (ø)`
x/gamm/client/cli/query.go	`36.74% <0.00%> (-0.36%)`	⬇️
x/gamm/pool-models/stableswap/amm.go	`40.27% <0.00%> (-15.50%)`	⬇️
x/gamm/pool-models/stableswap/msgs.go	`0.00% <0.00%> (ø)`
x/gamm/pool-models/stableswap/pool.go	`0.00% <0.00%> (ø)`
x/gamm/pool-models/stableswap/stableswap_pool.go	`0.00% <0.00%> (ø)`
.../gamm/pool-models/stableswap/stableswap_pool.pb.go	`0.58% <0.00%> (-0.09%)`	⬇️
x/gamm/types/pool.go	`0.00% <ø> (ø)`
x/incentives/client/cli/query.go	`0.00% <ø> (ø)`
x/incentives/keeper/distribute.go	`61.00% <0.00%> (ø)`
... and 48 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d812215...0ff98ce. Read the comment docs.

p0mvn

Nice work. I like the issue template. Left a couple of comments too, let me know what you think

.github/issue_template.md

.github/pull_request_template.md

Co-authored-by: Roman <[email protected]>

ValarDragon · 2022-05-03T19:42:18Z

.github/pull_request_template.md

-## Documentation and Release Note
-
-  - Does this pull request introduce a new feature or user-facing behavior changes? (yes / no)
-  - Is a relevant changelog entry added to the `Unreleased` section in `CHANGELOG.md`? (yes / no)
-  - How is the feature or change documented? (not applicable   /   specification (`x/<module>/spec/`)  /  [Osmosis docs repo](https://github.com/osmosis-labs/docs)   /   not documented)
-


I feel like this one was better, it forced acknowledgement of the options for docs updates

ValarDragon · 2022-05-03T19:42:56Z

.github/pull_request_template.md

-
-*(Please pick one of the following options)*
-
-This change is a trivial rework / code cleanup without any test coverage.
-
-*(or)*
-
-This change is already covered by existing tests, such as *(please describe tests)*.
-
-*(or)*
-
-This change added tests and can be verified as follows:
-
-*(example:)*


Do others dislike this? I thought this was great, I just choose the one I want and delete everything else

ValarDragon · 2022-05-03T19:43:39Z

.github/pull_request_template.md

-
-## Brief change log
-
+## Brief change log (include any info relevant to tests))


what is (include any info relevant to tests) for?

xBalbinus · 2022-05-03T19:44:39Z

Hmm, got it, depending on additional input I might just revert most if not all of the quick changes in the pr template…

…

On Tue, May 3, 2022 at 3:43 PM Dev Ojha ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In .github/pull_request_template.md <#1399 (comment)>: > - -*(Please pick one of the following options)* - -This change is a trivial rework / code cleanup without any test coverage. - -*(or)* - -This change is already covered by existing tests, such as *(please describe tests)*. - -*(or)* - -This change added tests and can be verified as follows: - -*(example:)* Do others dislike this? I thought this was great, I just choose the one I want and delete everything else — Reply to this email directly, view it on GitHub <#1399 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ASH4FPXBUCYMEK3JGMG77A3VIF6UZANCNFSM5U7VECAQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>

README.md

.github/pull_request_template.md

Co-authored-by: Aleksandr Bezobchuk <[email protected]>

xBalbinus · 2022-05-03T21:11:16Z

Alright folks! Reverted changes to pull_request_template.md but issue_template.md mostly remains the same. Also fixed @alexanderbez 's comment on README.md. Let me know what you all think :)

.github/pull_request_template.md

alexanderbez · 2022-05-03T21:29:30Z

.github/issue_template.md

@@ -0,0 +1,17 @@
+<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺


Shouldn't this exist under .github/ISSUE_TEMPLATE? Also, what kind of template is this? For bugs? I propose something like the following: https://github.com/umee-network/umee/blob/main/.github/ISSUE_TEMPLATE/bug-report.md

I didn't happen to know we had a .github/ISSUE_TEMPLATE already if we did (I don't happen to see it), I can definite create a /ISSUE_TEMPLATE folder though. And this was originally supposed to be for generic issues, not specifically bugs.

Yeah, we should have templates per type IMO (i.e. bugs, general proposal, features, etc...). Otherwise, having a template isn't all that useful.

Alright, I'll make that then

I think general proposals / features are done in a separate repo, and questions are done in our discord server, so I currently only implemented the bug reporter template, the generic issue template along with the option to still open blank issues. Let me know your thoughts :)

I think bug report and general template is fine. I don't really understand why features are done in a separate repo, but I don't wanna bike shed here.

.github/ISSUE_TEMPLATE/issue.md

p0mvn · 2022-05-04T17:52:25Z

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true


nit: missing new line at the end

xBalbinus · 2022-05-09T15:18:34Z

Just wondering, has this been merged in yet?

Co-authored-by: Aleksandr Bezobchuk <[email protected]>

xBalbinus added 2 commits May 3, 2022 13:42

contributing PR template simplifications

b46e2cd

added issues template

2a78bd3

xBalbinus requested review from daniel-farina, czarcas7ic and a team May 3, 2022 18:10

xBalbinus added 2 commits May 3, 2022 14:12

fixed spacing

03637ef

additional fixes

ce31f69

p0mvn reviewed May 3, 2022

View reviewed changes

.github/issue_template.md Outdated Show resolved Hide resolved

.github/pull_request_template.md Outdated Show resolved Hide resolved

xBalbinus and others added 3 commits May 3, 2022 14:37

Acceptance Criteria addition

7b1f36b

Co-authored-by: Roman <[email protected]>

feedback from roman implemented

a936e80

feedback from roman implemented

a6e7cdc

ValarDragon reviewed May 3, 2022

View reviewed changes

alexanderbez requested changes May 3, 2022

View reviewed changes

README.md Show resolved Hide resolved

.github/pull_request_template.md Outdated Show resolved Hide resolved

.github/pull_request_template.md Outdated Show resolved Hide resolved

xBalbinus and others added 2 commits May 3, 2022 17:07

reverting changes to pr template

685a437

Update README.md

51eda01

Co-authored-by: Aleksandr Bezobchuk <[email protected]>

alexanderbez reviewed May 3, 2022

View reviewed changes

xBalbinus added 2 commits May 3, 2022 18:05

issue / bug templates

9948af0

issue / bug templates

b2dce3f

github-actions bot added the Type:CI label May 3, 2022

alexanderbez approved these changes May 4, 2022

View reviewed changes

.github/ISSUE_TEMPLATE/issue.md Outdated Show resolved Hide resolved

p0mvn approved these changes May 4, 2022

View reviewed changes

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@

blank_issues_enabled: true

Copy link

Member

p0mvn May 4, 2022

Choose a reason for hiding this comment

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

nit: missing new line at the end

Merge branch 'main' into xiangan/contributing

9c82946

Merge branch 'main' into xiangan/contributing

0ff98ce

xBalbinus mentioned this pull request May 5, 2022

Write a contributing.md for Osmosis #891

Closed

xBalbinus and others added 3 commits May 9, 2022 12:00

Update .github/ISSUE_TEMPLATE/issue.md

c91c044

Co-authored-by: Aleksandr Bezobchuk <[email protected]>

Update .github/pull_request_template.md

786b2e7

Co-authored-by: Aleksandr Bezobchuk <[email protected]>

Merge branch 'main' into xiangan/contributing

323af7f

xBalbinus merged commit 524a2db into main May 9, 2022

xBalbinus deleted the xiangan/contributing branch May 9, 2022 17:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contributing.md link & PR template simplifications & Added ISSUE_TEMPLATE.md #1399

Contributing.md link & PR template simplifications & Added ISSUE_TEMPLATE.md #1399

xBalbinus commented May 3, 2022

codecov-commenter commented May 3, 2022 •

edited

Loading

p0mvn left a comment •

edited

Loading

ValarDragon May 3, 2022

ValarDragon May 3, 2022

ValarDragon May 3, 2022

xBalbinus commented May 3, 2022 via email

xBalbinus commented May 3, 2022

alexanderbez May 3, 2022

xBalbinus May 3, 2022

alexanderbez May 3, 2022

xBalbinus May 3, 2022

xBalbinus May 3, 2022

alexanderbez May 4, 2022

p0mvn May 4, 2022

xBalbinus commented May 9, 2022


		## Brief change log

		## Brief change log (include any info relevant to tests))

		@@ -0,0 +1,17 @@
		<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺

Contributing.md link & PR template simplifications & Added ISSUE_TEMPLATE.md #1399

Contributing.md link & PR template simplifications & Added ISSUE_TEMPLATE.md #1399

Conversation

xBalbinus commented May 3, 2022

What is the purpose of the change

Brief change log

Tests / Documentation

codecov-commenter commented May 3, 2022 • edited Loading

Codecov Report

p0mvn left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xBalbinus commented May 3, 2022 via email

xBalbinus commented May 3, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xBalbinus commented May 9, 2022

codecov-commenter commented May 3, 2022 •

edited

Loading

p0mvn left a comment •

edited

Loading