Skip to content

Commit 7fa1f5b

Browse files
authored
feat(doc): Add CONTRIBUTING.md (#375)
* feat(doc): Add CONTRIBUTING.md * feat(ci): Ensure that PRs are signed off
1 parent dafe3d2 commit 7fa1f5b

File tree

2 files changed

+104
-0
lines changed

2 files changed

+104
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Find signed commits
2+
on:
3+
pull_request_target:
4+
branches:
5+
- master # or the name of your main branch
6+
jobs:
7+
check-sign-off:
8+
name: Write comment if unsigned commits found
9+
env:
10+
FORCE_COLOR: 1
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: live627/check-pr-signoff-action@v1
15+
with:
16+
token: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
## Contributing In General
2+
Our project welcomes external contributions. If you have an itch, please feel
3+
free to scratch it.
4+
5+
To contribute code or documentation, please submit a [pull request](https://github.com/instana/python-sensor/pulls).
6+
7+
A good way to familiarize yourself with the codebase and contribution process is
8+
to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/instana/python-sensor/issues).
9+
<!--Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.-->
10+
11+
**Note: We appreciate your effort, and want to avoid a situation where a contribution
12+
requires extensive rework (by you or by us), sits in backlog for a long time, or
13+
cannot be accepted at all!**
14+
15+
### Proposing new features
16+
17+
If you would like to implement a new feature, please [raise an issue](https://github.com/instana/python-sensor/issues)
18+
before sending a pull request so the feature can be discussed. This is to avoid
19+
you wasting your valuable time working on a feature that the project developers
20+
are not interested in accepting into the code base.
21+
22+
### Fixing bugs
23+
24+
If you would like to fix a bug, please [raise an issue](https://github.com/instana/python-sensor/issues) before sending a
25+
pull request so it can be tracked.
26+
27+
<!--
28+
### Merge approval
29+
30+
The project maintainers use LGTM (Looks Good To Me) in comments on the code
31+
review to indicate acceptance. A change requires LGTMs from two of the
32+
maintainers of each component affected.
33+
34+
For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
35+
-->
36+
37+
## Legal
38+
39+
Each source file must include a license header for the MIT
40+
License. Using the SPDX format is the simplest approach.
41+
e.g.
42+
43+
```
44+
/*
45+
Copyright <holder> All Rights Reserved.
46+
47+
SPDX-License-Identifier: MIT
48+
*/
49+
```
50+
51+
We have tried to make it as easy as possible to make contributions. This
52+
applies to how we handle the legal aspects of contribution. We use the
53+
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)
54+
uses to manage code contributions.
55+
56+
We simply ask that when submitting a patch for review, the developer
57+
must include a sign-off statement in the commit message.
58+
59+
Here is an example Signed-off-by line, which indicates that the
60+
submitter accepts the DCO:
61+
62+
```
63+
Signed-off-by: John Doe <[email protected]>
64+
```
65+
66+
You can include this automatically when you commit a change to your
67+
local git repository using the following command:
68+
69+
```
70+
git commit -s
71+
```
72+
73+
<!--
74+
## Communication
75+
**FIXME** Please feel free to connect with us on our [Slack channel](link).
76+
77+
## Setup
78+
**FIXME** Please add any special setup instructions for your project to help the developer
79+
become productive quickly.
80+
81+
## Testing
82+
**FIXME** Please provide information that helps the developer test any changes they make
83+
before submitting.
84+
85+
## Coding style guidelines
86+
**FIXME** Optional, but recommended: please share any specific style guidelines you might
87+
have for your project.
88+
-->

0 commit comments

Comments
 (0)