Skip to content

Commit fe5e88a

Browse files
committed
docs: Update README and Contributing guide
1 parent 5908fb5 commit fe5e88a

File tree

2 files changed

+81
-11
lines changed

2 files changed

+81
-11
lines changed

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
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.md).
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.
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+
### Required Tools
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+
### Running Tests
40+
41+
To run the tests, use the following command:
42+
43+
```bash
44+
cargo test
45+
```
46+
47+
### Running Linter
48+
49+
To run the linter, use the following command:
50+
51+
```bash
52+
cargo clippy
53+
```
54+
55+
## Resources
56+
57+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
58+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
59+
- [GitHub Help](https://help.github.com)
60+
61+
[fork]: https://github.com/advanced-security/codeql-extractor-action/fork
62+
[pr]: https://github.com/advanced-security/codeql-extractor-action/compare
63+
[code-of-conduct]: https://github.com/advanced-security/codeql-extractor-action
64+

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313

1414
## Overview
1515

16-
[CodeQL Extractor Action][github] is a GitHub Action that helps [CodeQL] Extractor to integrate with GitHub Actions.
16+
[CodeQL Extractor Action][github] is a GitHub Action that allows you to specify a CodeQL extractor to be used in your workflows as an author of an Extractor.
17+
This action is designed to be used in conjunction with the [CodeQL][CodeQL] analysis tool, which is a powerful static analysis tool that can be used to find vulnerabilities in your code.
1718

1819
> [!WARNING]
1920
> This action downloads the extractor from the GitHub repository. Make sure to use a trusted repository, owner, and extractor.
@@ -38,20 +39,17 @@
3839
attestation: true
3940
```
4041
41-
## Maintainers / Contributors
42+
## Q&A
4243
43-
- [@GeekMasher](https://github.com/GeekMasher) - Author / Core Maintainer
44+
**Whats is an Extractor?**
4445
45-
## Support
46-
47-
Please create [GitHub Issues][github-issues] if there are bugs or feature requests.
46+
A CodeQL extractor is a tool that extracts code from a repository and prepares it for analysis by the CodeQL engine. It is used to convert the code into a format that can be analyzed by CodeQL.
4847
49-
This project uses [Sematic Versioning (v2)](https://semver.org/) and with major releases, breaking changes will occur.
48+
**How do I create an Extractor?**
5049
51-
## License
50+
To create an extractor, you need to create a GitHub repository that contains the extractor releases as an artifact / assest in a GitHub release.
51+
The extractor should be a Tarball file that contains the compiled extractor and all other necessary files for the extractor to run.
5252
53-
This project is licensed under the terms of the MIT open source license.
54-
Please refer to [MIT][license] for the full terms.
5553
5654
## Maintainers
5755
@@ -71,7 +69,15 @@ Please refer to [MIT][license] for the full terms.
7169
7270
## Support
7371
74-
Support is via [GitHub Issues][github-issues] or [GitHub Discussions][github-discussions].
72+
Please create [GitHub Issues][github-issues] if there are bugs or feature requests.
73+
74+
This project uses [Sematic Versioning (v2)](https://semver.org/) and with major releases, breaking changes will occur.
75+
76+
## License
77+
78+
This project is licensed under the terms of the MIT open source license.
79+
Please refer to [MIT][license] for the full terms.
80+
7581
7682
<!-- Resoucres -->
7783

0 commit comments

Comments
 (0)