Skip to content

[chore/task] Add issue and Pull request templates #5

@Ghat0tkach

Description

@Ghat0tkach

Currently, our project lacks standardized issue and pull request templates, making it challenging for contributors to provide essential information when creating issues or pull requests.

Proposed Solution:

  • Add clear and concise instructions on how to create issue and pull request templates for our project.

Instructions for Contributors:

To add issue and pull request templates to our project, follow these steps:

  1. Create a .github directory: Start by creating a .github directory at the root of our repository if it doesn't already exist.

  2. Inside the .github directory , create one subdirectory named ISSUE_TEMPLATE for issue templates and one filed named PULL_REQUEST_TEMPLATE.md for pull request templates.

  3. Create issue templates: Inside the ISSUE_TEMPLATE directory, create one or more Markdown files (e.g., bug_report.md, feature_request.md) representing different types of issues. These files will serve as templates for contributors to use when creating issues. You can provide a basic structure, headings, and guidelines in these templates.

  4. Create a pull request template: Inside the PULL_REQUEST_TEMPLATE.md file that contributors can use as a template for their pull requests. Include sections for a description, context, and a checklist for tasks that need to be completed.

Additional Information:
Feel free to ask any questions or seek clarification if you encounter any issues while implementing these instructions.


Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions