polarsource/polar

Create Pre-defined Templates for New Issue and Pull Request to Standardize Contributions

apsinghdev opened this issue · 3 comments

When we create a new issue or raise a pull request, we have to think by ourselves about what information we need to add for the issues or PR. Having pre-defined templates for creating a new issue and raising a pull request would be a good idea. It can benefit us in these manners:

  1. We don't have to think "What information do I need to provide?"
  2. Provides a consistent format for reporting bugs or feature requests.
  3. Standardized templates make it easier to review and understand submissions.
  4. Prompts users/contributors to include necessary details, reducing back-and-forth.
  5. Structured PR templates help reviewers assess changes more efficiently.

Below are some of the sample screenshots of how this feature would look like (If implemented):

Screenshot 2024-10-06 at 1 25 39 PM Screenshot 2024-10-06 at 1 27 27 PM Screenshot 2024-10-06 at 1 28 34 PM

@frankie567 what're your thoughts on this?

That's interesting @apsinghdev, thank you! A few comments:

  • I agree that an Issue template would be useful. However, I think I prefer traditional plain-text templates instead of the new form-style templates. It gives more flexibility IMO.
  • The template you propose looks great. I would just remove the version (doesn't really apply to us) and the disclaimer checkboxes
  • For Feature Request and Improvement, I would prefer to have a link (using the contact_links configuration) towards https://github.com/orgs/polarsource/discussions/new?category=feature-requests, so that's directed to Discussions directly instead of an Issue.
  • I would also like to have a link to our Discord for support requests (i.e. another contact_links item).

Random thoughts

  • An emoji (🪲, 💡 and 🛟) could be nice in the front of the title of each item

That's interesting @apsinghdev, thank you! A few comments:

  • I agree that an Issue template would be useful. However, I think I prefer traditional plain-text templates instead of the new form-style templates. It gives more flexibility IMO.
  • The template you propose looks great. I would just remove the version (doesn't really apply to us) and the disclaimer checkboxes
  • For Feature Request and Improvement, I would prefer to have a link (using the contact_links configuration) towards https://github.com/orgs/polarsource/discussions/new?category=feature-requests, so that's directed to Discussions directly instead of an Issue.
  • I would also like to have a link to our Discord for support requests (i.e. another contact_links item).

Random thoughts

  • An emoji (🪲, 💡 and 🛟) could be nice in the front of the title of each item

Thanks for your input. Onto it. I'll raise a PR soon.