Skip to content

Commit a2d96f4

Browse files
committed
docs: Update Docs
1 parent 34c3689 commit a2d96f4

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ If you have an idea for a new feature or enhancement, please open an issue on Gi
2828
3. Make your changes
2929
4. Write tests for your changes (if applicable)
3030
5. Run the tests to make sure everything is working
31+
6. Commit your changes with a clear commit message
32+
7. Push your changes to your fork
33+
8. Open a [pull request][pr] against the `main` branch of the original repository
3134

3235
### Required Tools
3336

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ A CodeQL extractor is a tool that extracts code from a repository and prepares i
5050
To create an extractor, you need to create a GitHub repository that contains the extractor releases as an artifact / assest in a GitHub release.
5151
The extractor should be a Tarball file that contains the compiled extractor and all other necessary files for the extractor to run.
5252
53-
54-
## Maintainers
53+
## Maintainers
5554
5655
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
5756
<!-- prettier-ignore-start -->
@@ -69,7 +68,7 @@ The extractor should be a Tarball file that contains the compiled extractor and
6968
7069
## Support
7170
72-
Please create [GitHub Issues][github-issues] if there are bugs or feature requests.
71+
Please create [GitHub Issues][github-issues] or [GitHub Discussion][github-discussions] if there are bugs or feature requests.
7372
7473
This project uses [Sematic Versioning (v2)](https://semver.org/) and with major releases, breaking changes will occur.
7574
@@ -78,13 +77,11 @@ This project uses [Sematic Versioning (v2)](https://semver.org/) and with major
7877
This project is licensed under the terms of the MIT open source license.
7978
Please refer to [MIT][license] for the full terms.
8079
81-
8280
<!-- Resoucres -->
8381
8482
[license]: ./LICENSE
8583
[github]: https://github.com/advanced-security/codeql-extractor-action
8684
[github-issues]: https://github.com/advanced-security/codeql-extractor-action/issues
8785
[github-actions]: https://github.com/advanced-security/codeql-extractor-action/actions
8886
[github-discussions]: https://github.com/advanced-security/codeql-extractor-action/discussions
89-
9087
[CodeQL]: https://codeql.github.com/

0 commit comments

Comments
 (0)