-
Notifications
You must be signed in to change notification settings - Fork 17
Description
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:
-
Create a
.githubdirectory: Start by creating a.githubdirectory at the root of our repository if it doesn't already exist. -
Inside the
.githubdirectory , create one subdirectory namedISSUE_TEMPLATEfor issue templates and one filed namedPULL_REQUEST_TEMPLATE.mdfor pull request templates. -
Create issue templates: Inside the
ISSUE_TEMPLATEdirectory, 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. -
Create a pull request template: Inside the
PULL_REQUEST_TEMPLATE.mdfile 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.