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.

Sign up for GitHub

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

Jump to bottom

[DRAFT] Adding guidelines for raising issues #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[DRAFT] Adding guidelines for raising issues #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,15 @@ How to get your contributions merged smoothly and quickly.
- `make testrace` to run tests in race mode

- For convenience, run `make setup` to run set relevant configurations, like a pre-commit hook to regenerate openapi docs on every commit to files in the server folder.
- Exceptions to the rules can be made if there's a compelling reason for doing so.
- Exceptions to the rules can be made if there's a compelling reason for doing so.

## Guidelines for Raising Issues

When raising issues, it's important to provide as much context and detail as possible. This helps maintainers and other contributors understand the issue and makes it easier for them to address it. Here's a template you can follow when creating a new issue:

- **Title**: Provide a clear and concise title that summarizes the issue.
- **Description**: Provide a detailed description of the issue. Include any relevant information that can help others understand the issue.
- **Steps to Reproduce**: Provide detailed steps to reproduce the issue. This should be a list of actions that lead to the issue occurring.
- **Expected Results**: Describe what you expected to happen when you followed the steps to reproduce.
- **Actual Results**: Describe what actually happened when you followed the steps to reproduce.
- **Error Messages/Logs**: If applicable, include any error messages or logs that are related to the issue.