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 documentation for issue reporters #2321

Open
Tracked by #2315
nojaf opened this issue Jul 1, 2022 · 0 comments
Open
Tracked by #2315

Add documentation for issue reporters #2321

nojaf opened this issue Jul 1, 2022 · 0 comments

Comments

@nojaf
Copy link
Contributor

nojaf commented Jul 1, 2022

We should have a section on how we want users to report problems or suggest issues.
There are issue templates in place but sometimes things we do or don't want are missing some context.
In no order:

  • Bugs should be reported using our online tool. Both soundness bugs and `stylistics bugs. If there is a gap between Fantomas and the F# style guide, it should also be reported using the online tool.
  • The online tool should not be used for feature requests.
  • https://github.com/fsprojects/fantomas/blob/master/CONTRIBUTING.md#what-are-we-not-looking-for should be repeated and expended. Maybe split up and shuffle things around.
  • We should also repeat that this is a community project, if you report an issue, you will be asked to tackle it yourself. Again, this needs some context using a friendly voice.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant