···1717 id: bug-description
1818 attributes:
1919 label: Describe the Bug
2020- description: A clear and concise description of what the bug is.
2121- validations:
2222- required: true
2323- - type: textarea
2424- id: bug-expectation
2525- attributes:
2626- label: What's the expected result?
2727- description: Describe what you expect to happen.
2828- validations:
2020+ description: A clear and concise description of what the bug is. Include any error messages you received, the expected behavior, and steps to reproduce if possible.
2121+ validations:
2922 required: true
3023 - type: checkboxes
3124 id: will-pr
+4-4
CONTRIBUTING.md
···55## Before Opening Issues
6677- **Do not report security vulnerabilities publicly** (e.g., in issues or discussions), please refer to our [security policy](https://github.com/bruits/maudit/blob/main/SECURITY.md).
88-- **Do not create issues for ideas or suggestions.** Instead, share your thoughts in our [GitHub Discussions](https://github.com/bruits/maudit/discussions/categories/ideas).
99-- **Do not create issues for questions.** Instead, ask your question in our [GitHub Discussions](https://github.com/bruits/maudit/discussions/categories/q-a) or on [our Discord](https://maudit.org/chat).
88+- **Do not create issues for questions about using Maudit.** Instead, ask your question in our [GitHub Discussions](https://github.com/bruits/maudit/discussions/categories/q-a) or on [our Discord](https://maudit.org/chat).
99+- **Do not create issues for ideas or suggestions.** Instead, share your thoughts in our [GitHub Discussions](https://github.com/bruits/maudit/discussions/categories/ideas) or on [our Discord](https://maudit.org/chat).
1010- **Check for duplicates.** Look through existing issues and discussions to see if your topic has already been addressed.
1111-- Provide as much detail as possible. However, donโt worry if itโs incompleteโwe will help refine it!
1111+- Please include a reproducible example to help us understand your issue.
1212+- In general, provide as much detail as possible. No worries if it's not perfect, we'll figure it out together.
12131314## Before submitting Pull Requests (PRs)
14151516- **Check for duplicates.** Look through existing PRs to see if your changes have already been submitted.
1616-- **Avoid trivial changes.** Don't submit PRs for typos, grammar, or insignificant changes, as they will be **declined** without review.
1717- PRs don't need to be perfect. Submit your best effort, and we will gladly assist in polishing the work.
18181919## Code of Conduct
+3-3
README.md
···10101111๐ฆ See the [crate](https://crates.io/crates/maudit) on Crates.io, and the [reference](https://docs.rs/maudit/latest/maudit/) on Docs.rs.
12121313-๐ [Report a bug](https://github.com/web-lsp/maudit/issues), please read our [contributing guidelines](#) and [code of conduct](#) first.
1313+๐ [Report a bug](https://github.com/bruits/maudit/issues), please read our [contributing guidelines](#) and [code of conduct](#) first.
14141515๐จ [Report a security vulnerability](#), and be sure to review our [security policy](#).
16161717-๐ฌ Join the discussion on [Github](https://github.com/web-lsp/maudit/discussions) and [Discord](https://maudit.org/chat/), if you have any questions, ideas, or suggestions.
1717+๐ฌ Join the discussion on [Github](https://github.com/bruits/maudit/discussions) and [Discord](https://maudit.org/chat/), if you have any questions, ideas, or suggestions.
18181919## Crates
20202121-*Work in progress.*
2121+_Work in progress._