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

doc: Contributing rules #32

Open
langston-barrett opened this issue Oct 25, 2022 · 1 comment
Open

doc: Contributing rules #32

langston-barrett opened this issue Oct 25, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone
v1.0.0

Comments

@langston-barrett
Copy link
Owner

langston-barrett commented Oct 25, 2022 •
edited

The documentation should have a section on how to contribute rules. It should cover benchmarking them on the files in bench/, link to the grammar, remind about rule categories, and link to sections on writing rules, building from source, and writing tests with lit.
@langston-barrett langston-barrett added the documentation Improvements or additions to documentation label Oct 25, 2022
@langston-barrett
Copy link
Owner Author

In the meantime, see #40 for how to add a rule.

@langston-barrett langston-barrett added this to the v1.0.0 milestone Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v1.0.0
Development

No branches or pull requests
1 participant
@langston-barrett