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

chore: improve GitHub Issue and PR templates #66

Closed
ruru-m07 opened this issue Aug 30, 2024 · 2 comments · Fixed by #76
Closed

chore: improve GitHub Issue and PR templates #66

ruru-m07 opened this issue Aug 30, 2024 · 2 comments · Fixed by #76
Assignees
Labels
help wanted Extra attention is needed workflow: update Updates to CI workflows or GitHub Actions.

Comments

@ruru-m07
Copy link
Owner

ruru-m07 commented Aug 30, 2024

We need to update and enhance the current GitHub Issue and Pull Request templates to make them more effective and user-friendly. The goal is to ensure that the templates guide contributors to provide all necessary information, resulting in clearer communication and more efficient issue tracking and code reviews. This includes refining the structure, adding helpful prompts, and ensuring consistency across the templates.


here is a reference of issue forms:

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

@ruru-m07
Copy link
Owner Author

ruru-m07 commented Aug 30, 2024

i ask this to ChatGPT and he gives something like this


Sure! Here’s a revised version of both the GitHub Issue and Pull Request templates.

GitHub Issue Template


Title:
A concise, descriptive title for the issue (use commit-like prefixes such as feat, fix, chore, etc.).


Description:
Provide a clear and detailed description of the issue or feature request. Include any relevant context, screenshots, or links to related issues. Explain the current behavior if it's a bug or the desired outcome if it's a feature.

Steps to Reproduce (for bugs):
If this is a bug report, list the steps needed to reproduce the issue. Include any code snippets, configurations, or specific conditions that lead to the bug.

  1. Step 1
  2. Step 2
  3. Step 3

Expected Behavior:
Describe what you expected to happen.

Actual Behavior:
Describe what actually happened. Include any error messages or unexpected results.

Possible Solution:
If you have any suggestions for fixing the issue, describe them here. This can include code snippets, links to relevant documentation, or any insights you have.

Environment:
Provide details about the environment where the issue occurred. Include information such as:

  • OS:
  • Browser (if applicable):
  • Node.js version:
  • NPM/Yarn version:
  • Any other relevant details:

Additional Context/Information:
Include any other context, logs, or screenshots that might help understand the issue better.


Pull Request Template


Title:
A concise, descriptive title for the PR (use commit-like prefixes such as feat, fix, chore, etc.).


Description:
Provide a summary of the changes introduced by this pull request. Explain the purpose of the changes, the problem they solve, or the feature they implement.

Related Issues:
If this PR addresses any existing issues, link them here (e.g., "Fixes #123").

Changes Made:
List the key changes made in the PR. Break down the changes into bullet points, making it clear what was added, modified, or removed.

  • Change 1
  • Change 2
  • Change 3

Testing:
Describe how the changes were tested. Include details on manual testing, unit tests, integration tests, and any other testing methods used to verify the changes.

Screenshots (if applicable):
Include any relevant screenshots or GIFs that show the changes in action.

Types of Changes:
Indicate the type of changes introduced in this PR. You can mark more than one if applicable.

  • feat: New feature
  • fix: Bug fix
  • chore: Maintenance task
  • docs: Documentation update
  • refactor: Code refactoring
  • style: Formatting, missing semicolons, etc.
  • test: Adding or updating tests

Checklist:
Before submitting your PR, go through this checklist to ensure everything is complete:

  • I have followed the coding standards for this project.
  • I have updated the documentation accordingly.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have run npm run lint and npm run test to check for any code issues.
  • I have added the necessary labels to this PR.

Additional Notes:
Include any additional information that might be important for the reviewers. This can include implementation details, known issues, or anything else that may help in understanding the PR.


These templates are designed to make it easier to describe issues and pull requests clearly, helping maintain consistency and clarity in your project’s workflow.

@ruru-m07 ruru-m07 added help wanted Extra attention is needed workflow: update Updates to CI workflows or GitHub Actions. labels Aug 30, 2024
@ruru-m07 ruru-m07 pinned this issue Aug 30, 2024
@ruru-m07
Copy link
Owner Author

close #66

@ruru-m07 ruru-m07 self-assigned this Sep 26, 2024
@ruru-m07 ruru-m07 unpinned this issue Oct 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed workflow: update Updates to CI workflows or GitHub Actions.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant