From c759174adc5dfa24bf854393139839c2a19069fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferenc=20G=C3=A9czi?= Date: Thu, 30 Jun 2022 00:00:00 +0000 Subject: [PATCH 1/2] feat(doc): Add CONTRIBUTING.md --- CONTRIBUTING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..afeeab0e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +## Contributing In General +Our project welcomes external contributions. If you have an itch, please feel +free to scratch it. + +To contribute code or documentation, please submit a [pull request](https://github.com/instana/python-sensor/pulls). + +A good way to familiarize yourself with the codebase and contribution process is +to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/instana/python-sensor/issues). + + +**Note: We appreciate your effort, and want to avoid a situation where a contribution +requires extensive rework (by you or by us), sits in backlog for a long time, or +cannot be accepted at all!** + +### Proposing new features + +If you would like to implement a new feature, please [raise an issue](https://github.com/instana/python-sensor/issues) +before sending a pull request so the feature can be discussed. This is to avoid +you wasting your valuable time working on a feature that the project developers +are not interested in accepting into the code base. + +### Fixing bugs + +If you would like to fix a bug, please [raise an issue](https://github.com/instana/python-sensor/issues) before sending a +pull request so it can be tracked. + + + +## Legal + +Each source file must include a license header for the MIT +License. Using the SPDX format is the simplest approach. +e.g. + +``` +/* +Copyright All Rights Reserved. + +SPDX-License-Identifier: MIT +*/ +``` + +We have tried to make it as easy as possible to make contributions. This +applies to how we handle the legal aspects of contribution. We use the +same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin) +uses to manage code contributions. + +We simply ask that when submitting a patch for review, the developer +must include a sign-off statement in the commit message. + +Here is an example Signed-off-by line, which indicates that the +submitter accepts the DCO: + +``` +Signed-off-by: John Doe +``` + +You can include this automatically when you commit a change to your +local git repository using the following command: + +``` +git commit -s +``` + + From 09d45c54bf0c9f239098293adbd9e5d1f8ca0025 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferenc=20G=C3=A9czi?= Date: Thu, 30 Jun 2022 00:00:00 +0000 Subject: [PATCH 2/2] feat(ci): Ensure that PRs are signed off --- .github/workflows/pr_commits_signed_off.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/workflows/pr_commits_signed_off.yml diff --git a/.github/workflows/pr_commits_signed_off.yml b/.github/workflows/pr_commits_signed_off.yml new file mode 100644 index 00000000..fc291eb2 --- /dev/null +++ b/.github/workflows/pr_commits_signed_off.yml @@ -0,0 +1,16 @@ +name: Find signed commits +on: + pull_request_target: + branches: + - master # or the name of your main branch +jobs: + check-sign-off: + name: Write comment if unsigned commits found + env: + FORCE_COLOR: 1 + runs-on: ubuntu-latest + + steps: + - uses: live627/check-pr-signoff-action@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }}