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.

Sign up for GitHub

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

Jump to bottom

enrich existing PR template to smooth the review process #1261

Closed
jlbit opened this issue Apr 16, 2022 · 2 comments · Fixed by #1264
Closed

enrich existing PR template to smooth the review process #1261

jlbit opened this issue Apr 16, 2022 · 2 comments · Fixed by #1264

Comments

@jlbit
Copy link
Contributor

jlbit commented Apr 16, 2022

As discussed with @ValarDragon, currently Osmosis's existing pr template is a bit over simplified with only "Description" field required.

I'd like propose adding a bit more templating to help smooth the review process, as well as fostering a engineering habit of emphasizing documentations, e.g. when a new feature released or user-facing behavior changed, PR submitters should always keep in mind updating the docs at the same time in https://github.com/osmosis-labs/docs.
@daniel-farina daniel-farina moved this to 🔍 Needs Review in Osmosis Chain Development Apr 16, 2022
@jlbit
Copy link
Contributor Author

jlbit commented Apr 16, 2022

on the other hand, the template should not be overcomplicated like the one in cosmos SDK, which has too many checkboxes that makes it unreadable and thus no one taking it seriously anymore

@jlbit
Copy link
Contributor Author

jlbit commented Apr 16, 2022

this should be a very similar one to which I proposed in osmosis's doc repo osmosis-labs/docs#68

@jlbit jlbit mentioned this issue Apr 16, 2022
Merged
Repository owner moved this from 🔍 Needs Review to ✅ Done in Osmosis Chain Development Apr 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Osmosis Chain Development
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

enrich existing PR template to smooth the review process jlbit/osmosis
1 participant
@jlbit