|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. |
| 4 | + |
| 5 | +Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license][license]. |
| 6 | + |
| 7 | +Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms. |
| 8 | + |
| 9 | +## Reporting Bugs |
| 10 | + |
| 11 | +The best way to report a bug is to open an issue on GitHub. Please include as much information as possible, including: |
| 12 | + |
| 13 | +- A clear description of the problem |
| 14 | +- Steps to reproduce the problem |
| 15 | +- The expected behavior |
| 16 | +- The actual behavior |
| 17 | + |
| 18 | +This will help us understand the issue and fix it more quickly. |
| 19 | + |
| 20 | +## Suggesting Enhancements |
| 21 | + |
| 22 | +If you have an idea for a new feature or enhancement, [please open an issue on GitHub][issues]. |
| 23 | + |
| 24 | +## Submitting Changes |
| 25 | + |
| 26 | +1. [Fork][fork] and clone the repository |
| 27 | +2. Create a new branch for your changes |
| 28 | +3. Make your changes |
| 29 | +4. Write tests for your changes (if applicable) |
| 30 | +5. Run the tests to make sure everything is working |
| 31 | + |
| 32 | +### Requirements |
| 33 | + |
| 34 | +- [Rust](https://www.rust-lang.org/tools/install) |
| 35 | +- [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) |
| 36 | +- [CodeQL](https://codeql.github.com/docs/codeql-cli/getting-started/) |
| 37 | + - `gh-codeql` is a great tool to help you with CodeQL CLI. |
| 38 | + |
| 39 | +### Cloning the Repository |
| 40 | + |
| 41 | +To clone the repository, run the following command: |
| 42 | + |
| 43 | +```bash |
| 44 | +git clone https://github.com/GitHubSecurityLab/codeql-extractor-bicep |
| 45 | +git submodule update --init --recursive |
| 46 | +``` |
| 47 | + |
| 48 | +> ![NOTE] |
| 49 | +> This repository uses submodules to manage the Tree-Sitter grammar from the language. |
| 50 | +
|
| 51 | +### Building Extractor Pack |
| 52 | + |
| 53 | +There is a script to build the extractor pack. You can run it from the root of the repository: |
| 54 | + |
| 55 | +```bash |
| 56 | +./scripts/create-extractor-pack.sh |
| 57 | +``` |
| 58 | + |
| 59 | +### Testing CodeQL Libraries and Queries |
| 60 | + |
| 61 | +To test the CodeQL libraries and queries, you can run the following command: |
| 62 | + |
| 63 | +```bash |
| 64 | +./scripts/run-tests.sh |
| 65 | +``` |
| 66 | + |
| 67 | +## Resources |
| 68 | + |
| 69 | +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) |
| 70 | +- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) |
| 71 | +- [GitHub Help](https://help.github.com) |
| 72 | + |
| 73 | +[issues]: https://github.com/GitHubSecurityLab/codeql-extractor-bicep/issues |
| 74 | +[fork]: https://github.com/GitHubSecurityLab/codeql-extractor-bicep/fork |
| 75 | +[pr]: https://github.com/GitHubSecurityLab/codeql-extractor-bicep/compare |
| 76 | +[license]: https://github.com/GitHubSecurityLab/codeql-extractor-bicep/tree/main/LICENSE |
| 77 | +[code-of-conduct]: https://github.com/GitHubSecurityLab/codeql-extractor-bicep/tree/main?tab=coc-ov-file |
0 commit comments