acmjec / acmjec-website-hacktoberfest2023

6 stars 17 forks source link

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

Open Ghat0tkach opened 1 year ago

Ghat0tkach commented 1 year ago

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:

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.


arif78699 commented 1 year ago

Please assign to me, i want to work on it.

atharv-av commented 1 year ago

Hello Arif, you are now an assignee for this issue.

Ghat0tkach commented 1 year ago

Hello @arif78699 , if you aren't working on this issue , could I take it over?

Thanks