You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our project welcomes external contributions. If you have an itch, please feel
3
4
free to scratch it.
4
5
5
-
To contribute code or documentation, please submit a [pull request](https://github.com/instana/python-sensor/pulls).
6
+
To contribute with code, please submit a [pull request].
6
7
7
8
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
+
to look for and tackle low-hanging fruit in the [issue tracker].
10
+
9
11
<!--Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.-->
10
12
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!**
13
+
**Note: We appreciate your effort, and want to avoid a situation where a
14
+
contribution requires extensive rework (by you or by us), sits in backlog for a
15
+
long time, or cannot be accepted at all!**
14
16
15
-
###Proposing new features
17
+
## Proposing new features
16
18
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
+
If you would like to implement a new feature, please [raise an issue] before
20
+
sending a pull request so the feature can be discussed. This is to avoid
19
21
you wasting your valuable time working on a feature that the project developers
20
22
are not interested in accepting into the code base.
21
23
22
-
### Fixing bugs
24
+
Do not forget to add the labels `enhancement` or `feature` to your issue.
25
+
26
+
## Fixing bugs
23
27
24
-
If you would like to fix a bug, please [raise an issue](https://github.com/instana/python-sensor/issues) before sending a
28
+
If you would like to fix a bug, please [raise an issue] before sending a
25
29
pull request so it can be tracked.
26
30
27
-
### Merge approval
31
+
Do not forget to add the label `bug` to your issue.
28
32
29
-
The project maintainers use LGTM (Looks Good To Me) in comments on the code
30
-
review to indicate acceptance. A change requires LGTMs from two of the
31
-
maintainers of each component affected.
33
+
## Merge approval
34
+
35
+
The project maintainers use `LGTM` (Looks Good To Me) in comments on the code
36
+
review to indicate acceptance. A pull request requires LGTMs from, at least, one
37
+
of the maintainers of each component affected.
32
38
33
39
For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
34
40
35
41
## Legal
36
42
37
-
Each source file must include a license header for the MIT
38
-
License. Using the SPDX format is the simplest approach.
39
-
e.g.
43
+
### Copyright
44
+
45
+
Each source file must include a Copyright header to IBM. When submitting a pull
46
+
request for review which contains new source code files, the developer must
47
+
include the following content in the beginning of the file.
40
48
41
49
```
42
-
/*
43
-
Copyright <holder> All Rights Reserved.
50
+
# (c) Copyright IBM Corp. <YEAR>
44
51
45
-
SPDX-License-Identifier: MIT
46
-
*/
47
52
```
48
53
54
+
### Sign your work
55
+
49
56
We have tried to make it as easy as possible to make contributions. This
50
-
applies to how we handle the legal aspects of contribution. We use the
51
-
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)
52
-
uses to manage code contributions.
57
+
applies to how we handle the legal aspects of contribution.
58
+
59
+
We use the same approach - the [Developer's Certificate of Origin 1.1 (DCO)] - that the [Linux® Kernel community]uses to manage code contributions.
53
60
54
-
We simply ask that when submitting a patch for review, the developer
61
+
We simply ask that when submitting a pull request for review, the developer
55
62
must include a sign-off statement in the commit message.
56
63
57
64
Here is an example Signed-off-by line, which indicates that the
@@ -64,7 +71,7 @@ Signed-off-by: John Doe <john.doe@example.com>
64
71
You can include this automatically when you commit a change to your
65
72
local git repository using the following command:
66
73
67
-
```
74
+
```shell
68
75
git commit -s
69
76
```
70
77
@@ -84,3 +91,11 @@ before submitting.
84
91
**FIXME** Optional, but recommended: please share any specific style guidelines you might
_Note: To release a new Instana package, you must be a project member of the [Instana package project on Pypi](https://pypi.org/project/instana/).
6
-
Contact [Peter Giacomo Lombardo](https://github.com/pglombardo) to be added._
7
-
8
-
1. Before releasing, assure that [tests have passed](https://circleci.com/gh/instana/workflows/python-sensor) and that the package has also been manually validated in various stacks.
3. Bump the package version in `instana/version.py`. `git` commit & push the version change to the `main` branch
11
-
4. Create a [draft Release on Github](https://github.com/instana/python-sensor/releases) using [./bin/create_general_release.py](https://github.com/instana/python-sensor/blob/main/bin/create_general_release.py)
12
-
5. Run `python setup.py sdist bdist_wheel` to create the packages file in `./dist/`
13
-
6. Upload the package to Pypi with twine: `twine upload dist/instana-<version>*`
14
-
7. Validate the new release on https://pypi.org/project/instana/
15
-
8. Update Python documentation with latest changes: https://docs.instana.io/ecosystem/python/
16
-
9. Publish the draft release on [Github](https://github.com/instana/python-sensor/releases)
17
-
10. Ensure that the new [Concourse CI resource version](
and its downstream jobs are successfull. In particular the `run-test-suite` doesn't report any errors.
3
+
## PyPI and GitHub
4
+
5
+
The project has a GitHub Action that publishes new versions of the Instana Python Tracer to GitHub and [PyPI] using the [Trusted Publisher Management System].
6
+
7
+
Only the GitHub `@instana/python-eng` team members are allowed to publish a new version of the Instana Python Tracer.
22
8
23
9
## AWS Lambda Layer
24
10
25
-
To release a new AWS Lambda layer, see `bin/aws-lambda/lambda_build_publish_layer.py`.
11
+
On top of the common Instana Python Tracer release, the GitHub `@instana/python-eng` team members also publish versions of the Instana Python Tracer AWS Lambda layer.
0 commit comments