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 Issue Templates for Bug Report, Feature Request, Documentation, and General Issues #93

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

q-pratz-chem
Copy link
Collaborator

Description
This PR adds a set of issue templates to the repository to standardize the reporting of issues, questions, feature requests, and documentation concerns. These templates aim to improve the process of reporting problems and making feature requests, ensuring that all necessary details are provided for faster resolution.

Changes Included:

  1. question.md - Template for users to ask questions or seek clarifications about the project. It includes sections like:
  • Question description
  • Context (e.g., environment or specific use case)
  • Steps taken so far
  • Expected outcomes
  1. general_issues.md - Template for reporting general issues, bugs, or enhancements. It allows users to describe the issue in detail, include steps to reproduce, and specify expected vs. actual behavior.
  2. feature_request.md - Template for proposing new features or improvements. It includes sections for a brief summary, motivation, proposed solution, and any alternative solutions considered.
  3. documentation_issue.md - Template for reporting issues with the documentation, including unclear or outdated information, and suggesting improvements.
  4. bug_report.md - Default bug report template for users to describe issues encountered with the project. It includes fields for:
  • Description
  • Steps to reproduce
  • Expected vs. actual behavior
  • System environment details

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant