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 PR Template and General Issue Template #179

Closed
3 tasks
samriddhi99 opened this issue Sep 17, 2024 · 2 comments
Closed
3 tasks

Add PR Template and General Issue Template #179

samriddhi99 opened this issue Sep 17, 2024 · 2 comments
Assignees
Labels
good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@samriddhi99
Copy link
Contributor

It would be helpful to add the following templates to this repository to ensure consistency and improve the quality of both PRs and issues:

1. Pull Request (PR) Template:

A PR template will guide contributors to provide the necessary information when opening a PR, such as:

  • What changes are being made
  • Why the changes are necessary
  • What effects those changes have
  • Any related issues or tickets
  • Testing

It is also recommended to have a checklist that looks like this:

  • Checklist:
    • Code has been linted.
    • Documentation has been updated (if needed).
    • Tests have been added or updated (if needed).

2. General Issue Template:

Tirith already has templates for bug reports and feature requests. It would be useful to introduce a general issue template for cases that don't fall into either of those categories.

The template should include:

  • Provide a detailed description of their issue.
  • Outline any expected or unexpected behaviors observed in the code.
@samriddhi99 samriddhi99 added good first issue Good for newcomers help wanted Extra attention is needed hacktoberfest labels Sep 17, 2024
@Denish3436
Copy link
Contributor

@samriddhi99 I would like to work, can you please assign me....

@Denish3436
Copy link
Contributor

I Really apologies for above closed PR....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants