Skip to content

Commit

Permalink
Add a bit of info on contributing to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jlapeyre committed Mar 26, 2024
1 parent 22b55cc commit 2d582e3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,3 @@ cargo fmt --all -- --check && cargo build --verbose && cargo clippy -- -D warnin

One of the CI items is `cargo clippy`.
To handle a lot of errors at the command line you can use (for unix-like OS) `cargo clippy --color always &| less -R`.


8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Differences with the [OpenQASM reference parser](https://github.com/openqasm/ope
A crude test with large source files showed parse time reduced by a factor of 80.
* `openqasm3_parser` performs semantic analysis.

### Contributing

If you are interested in contributing, browsing the issues is a good place to start.
Some of the issues are [tagged with the label "Looking for assignee"](https://github.com/Qiskit/openqasm3_parser/issues?q=label%3A%22Looking+for+assignee%22+is%3Aopen+sort%3Aupdated-desc).
Issues with the tag include a bit more context than some other issues in order to guide a newcomer. Also, the core developers are not
planning on working on these issues in the immediate future.
However, this does not mean you can't tackle an issue without this tag if is a better fit.

### Crates (roughly one installable library per crate)

The first three crates are based on tools for `rust` and `rust-analyzer`.
Expand Down

0 comments on commit 2d582e3

Please sign in to comment.