Skip to content

Commit 0b34257

Browse files
committed
chore: Update author's info and project files.
Signed-off-by: Paulo Vital <paulo.vital@ibm.com>
1 parent 905a32d commit 0b34257

File tree

3 files changed

+53
-54
lines changed

3 files changed

+53
-54
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,64 @@
1-
## Contributing In General
1+
# Contributing to the Instana Python Sensor
2+
23
Our project welcomes external contributions. If you have an itch, please feel
34
free to scratch it.
45

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].
67

78
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+
911
<!--Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.-->
1012

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!**
1416

15-
### Proposing new features
17+
## Proposing new features
1618

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
1921
you wasting your valuable time working on a feature that the project developers
2022
are not interested in accepting into the code base.
2123

22-
### Fixing bugs
24+
Do not forget to add the labels `enhancement` or `feature` to your issue.
25+
26+
## Fixing bugs
2327

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
2529
pull request so it can be tracked.
2630

27-
### Merge approval
31+
Do not forget to add the label `bug` to your issue.
2832

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.
3238

3339
For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
3440

3541
## Legal
3642

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.
4048

4149
```
42-
/*
43-
Copyright <holder> All Rights Reserved.
50+
# (c) Copyright IBM Corp. <YEAR>
4451
45-
SPDX-License-Identifier: MIT
46-
*/
4752
```
4853

54+
### Sign your work
55+
4956
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.
5360

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
5562
must include a sign-off statement in the commit message.
5663

5764
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>
6471
You can include this automatically when you commit a change to your
6572
local git repository using the following command:
6673

67-
```
74+
```shell
6875
git commit -s
6976
```
7077

@@ -84,3 +91,11 @@ before submitting.
8491
**FIXME** Optional, but recommended: please share any specific style guidelines you might
8592
have for your project.
8693
-->
94+
95+
<!-- Reference links -->
96+
97+
[pull request]: https://github.com/instana/python-sensor/pulls "Python Sensor Pull Requests"
98+
[issue tracker]: https://github.com/instana/python-sensor/issues "Python Sensor Issue Tracker"
99+
[raise an issue]: https://github.com/instana/python-sensor/issues "Raise an issue"
100+
[Developer's Certificate of Origin 1.1 (DCO)]: https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt "DCO1.1"
101+
[Linux® Kernel community]: https://elinux.org/Developer_Certificate_Of_Origin "Linux Kernel DCO"

RELEASE.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,18 @@
11
# Release Steps
22

3-
## PyPI
4-
5-
_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.
9-
2. `git checkout main && git pull --rebase && pip install -U twine`
10-
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](
18-
https://ci.instana.io/teams/tracer-community/pipelines/tracer-test-suite:main/resources/instana-python-package)
19-
has been discovered. Trigger it manually if the automation doesn't do it. Also ensure that the [update job](
20-
https://ci.instana.io/teams/tracer-community/pipelines/tracer-test-suite%3Amain/jobs/update-python-package/)
21-
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.
228

239
## AWS Lambda Layer
2410

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.
2612

27-
```bash
28-
./bin/aws-lambda/build_and_publish_lambda_layer.py [-dev|-prod]
29-
./bin/create_lambda_release.py <version>
30-
```
13+
These releases are available on the GitHub Releases page.
3114

32-
These scripts assume that you have the AWS CLI and Github CLI installed and credentials already configured.
15+
<!-- Reference links -->
3316

34-
Post release, remember to update documentation and the Instana UI.
17+
[PyPI]: https://pypi.org/project/instana/ "Instana Python Tracer on PyPI"
18+
[Trusted Publisher Management System]: https://docs.pypi.org/trusted-publishers/ "Trusted Publisher Management System"

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ keywords = [
2020
"distributed-tracing",
2121
]
2222
authors = [
23-
{ name = "Instana Team Python Tracer Engineers" },
23+
{ name = "Instana Python Tracer Engineers", email = "pythonrubyinstana@ibm.com" },
2424
]
2525
classifiers = [
2626
"Development Status :: 5 - Production/Stable",

0 commit comments

Comments
 (0)