wehub-resource-sync
2114ccd278
CI / Lint & Test (Python 3.13) (push) Failing after 2s
CI / Lint & Test (Python 3.14) (push) Failing after 1s
CI / Lint & Test (Python 3.12) (push) Failing after 2s
CI / DCO Check (push) Has been skipped
Scorecard supply-chain security / Scorecard analysis (push) Failing after 2s
75 lines
2.6 KiB
Markdown
75 lines
2.6 KiB
Markdown
# Contributing to SkillSpector
|
|
|
|
We welcome contributions to SkillSpector! By contributing, you agree to abide
|
|
by the [Developer Certificate of Origin](#developer-certificate-of-origin).
|
|
|
|
## How to Contribute
|
|
|
|
1. **Open an issue** describing the bug or feature you'd like to work on.
|
|
2. **Fork** the repository and create a branch for your change.
|
|
3. **Make your changes**, ensuring all tests pass (`make test`).
|
|
4. **Sign off** every commit (see below).
|
|
5. **Open a pull request** referencing the issue.
|
|
|
|
## Coding Standards
|
|
|
|
- Run `make lint` and `make format` before submitting.
|
|
- All new source files must include the SPDX license header (see any existing
|
|
`.py` file for the template).
|
|
- New analyzers should include corresponding unit tests and, where applicable,
|
|
test fixtures.
|
|
|
|
## Commit Sign-Off
|
|
|
|
All contributions must include a `Signed-off-by` line in the commit message,
|
|
certifying that you have the right to submit the work under the project's
|
|
open-source license. Use `git commit -s` to add this automatically:
|
|
|
|
```
|
|
feat(analyzer): add new detection rule for X
|
|
|
|
Signed-off-by: Your Name <your.email@example.com>
|
|
```
|
|
|
|
This sign-off certifies that you agree to the Developer Certificate of Origin
|
|
(DCO) below.
|
|
|
|
## Developer Certificate of Origin
|
|
|
|
```
|
|
Developer Certificate of Origin
|
|
Version 1.1
|
|
|
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
|
|
|
Everyone is permitted to copy and distribute verbatim copies of this
|
|
license document, but changing it is not allowed.
|
|
|
|
|
|
Developer's Certificate of Origin 1.1
|
|
|
|
By making a contribution to this project, I certify that:
|
|
|
|
(a) The contribution was created in whole or in part by me and I
|
|
have the right to submit it under the open source license
|
|
indicated in the file; or
|
|
|
|
(b) The contribution is based upon previous work that, to the best
|
|
of my knowledge, is covered under an appropriate open source
|
|
license and I have the right under that license to submit that
|
|
work with modifications, whether created in whole or in part
|
|
by me, under the same open source license (unless I am
|
|
permitted to submit under a different license), as indicated
|
|
in the file; or
|
|
|
|
(c) The contribution was provided directly to me by some other
|
|
person who certified (a), (b) or (c) and I have not modified
|
|
it.
|
|
|
|
(d) I understand and agree that this project and the contribution
|
|
are public and that a record of the contribution (including all
|
|
personal information I submit with it, including my sign-off) is
|
|
maintained indefinitely and may be redistributed consistent with
|
|
this project or the open source license(s) involved.
|
|
```
|