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

add github templates for issues and prs for easier tracking #3685

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

nghuyenthevinh2000
Copy link

@nghuyenthevinh2000 nghuyenthevinh2000 commented Apr 25, 2024

I notice that ord is receiving a lot of community contributions, questions, thus a need for a template to easily follow and manage. Things are definitely going wild after runes launch 🤣

This pr adds:

  1. Issue templates
  • bug report
  • documentation request
  • feature request
  1. pull request template

it will look like so:
Screenshot 2024-04-25 at 15 11 30
Screenshot 2024-04-25 at 15 24 29

@raphjaph
Copy link
Collaborator

raphjaph commented May 6, 2024

Personally I'm not a big fan of issue templates since they add a lot of friction and boilerplate when I want to add an issue. I'm open to having my mind changes though. Do you maybe have an example repo where these kind of templates are used? That way I can get a feeling for how it is used in practice.

@nghuyenthevinh2000
Copy link
Author

nghuyenthevinh2000 commented May 6, 2024

let's reason from the maintainer perspective,

Currently Ord has 390 issues, a huge number and will continue to increase. Some of it may contain critical bugs but poor issue description, some may contain a brilliant feature idea but unattractive issue name. As a maintainer, how to quickly scan all these issues and maximize the chance of discovery, also spending less time reading all these strange looking issues?

With issue templates, people now have a framework to describe what they want (ofc some will not follow but you can refer them to a template that they need to follow, so now they have to spend time actually describing their problems seriously). Plus, it will auto - assign a tag upon issue creation. Now, you lose less time scanning which are "bug", "documentation", "features". Upon clicking one, you can already see a clearly defined problem (with environment, ord version, inputs, ...) instead of just a name and some summaries.

With pull request templates, people now have to clearly define what they want to submit, and relevant test before your review.

I understand the pain of maintaining an open source project (here is mine: https://github.com/classic-terra/core), looking through all poorly defined issues, PRs can be real crazy sometimes. So, these templates help your sanity. All of these are based on cosmos-sdk: https://github.com/cosmos/cosmos-sdk, they have really good system of github actions to flag issues, prs, auto tagging exactly which components are affected based on changed codes. All of these is to help save time of maintainers.

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.

2 participants