mirror of
https://github.com/prometheus-operator/kube-prometheus.git
synced 2025-10-26 21:51:00 +01:00
split contribution doc into a separate file
Signed-off-by: paulfantom <pawel@krupa.net.pl>
This commit is contained in:
paulfantom
parent
2c25661fad
commit
2f7a034ee7
102
CONTRIBUTING.md
Normal file
102
CONTRIBUTING.md
Normal file
@ -0,0 +1,102 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
This project is licensed under the [Apache 2.0 license](LICENSE) and accept
|
||||||
|
contributions via GitHub pull requests. This document outlines some of the
|
||||||
|
conventions on development workflow, commit message formatting, contact points
|
||||||
|
and other resources to make it easier to get your contribution accepted.
|
||||||
|
|
||||||
|
To maintain a safe and welcoming community, all participants must adhere to the
|
||||||
|
project's [Code of Conduct](code-of-conduct.md).
|
||||||
|
|
||||||
|
## Certificate of Origin
|
||||||
|
|
||||||
|
By contributing to this project you agree to the Developer Certificate of
|
||||||
|
Origin (DCO). This document was created by the Linux Kernel community and is a
|
||||||
|
simple statement that you, as a contributor, have the legal right to make the
|
||||||
|
contribution. See the [DCO](DCO) file for details.
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
The project is developed in the open. Here are some of the channels we use to communicate and contribute:
|
||||||
|
|
||||||
|
[**Kubernetes Slack**](https://slack.k8s.io/): [#prometheus-operator](https://kubernetes.slack.com/archives/CFFDS2Z7F) -
|
||||||
|
General discussions channel
|
||||||
|
|
||||||
|
[**Kubernetes Slack**](https://slack.k8s.io/): [#prometheus-operator-dev](https://kubernetes.slack.com/archives/C01B03QCSMN) -
|
||||||
|
Channel used for project developers discussions
|
||||||
|
|
||||||
|
**Discussion forum**: [GitHub discussions](https://github.com/prometheus-operator/kube-prometheus/discussions)
|
||||||
|
|
||||||
|
**Twitter**: [@PromOperator](https://twitter.com/promoperator)
|
||||||
|
|
||||||
|
**GitHub**: To file bugs and feature requests. For questions and discussions use the GitHub discussions. Generally,
|
||||||
|
the other community channels listed here are best suited to get support or discuss overarching topics.
|
||||||
|
|
||||||
|
Please avoid emailing maintainers directly.
|
||||||
|
|
||||||
|
We host publicy bi-weekly meetings focused on project development and contributions. It’s meant for developers
|
||||||
|
and maintainers to meet and get unblocked, pair review, and discuss development aspects of this project and related
|
||||||
|
projects (e.g kubernetes-mixin). The document linked below contains all the details, including how to register.
|
||||||
|
|
||||||
|
**Office Hours**: [Prometheus Operator & Kube-prometheus Contributor Office Hours](https://docs.google.com/document/d/1-fjJmzrwRpKmSPHtXN5u6VZnn39M28KqyQGBEJsqUOk)
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
- Fork the repository on GitHub
|
||||||
|
- Read the [README](README.md) for build and test instructions
|
||||||
|
- Play with the project, submit bug fixes, submit patches!
|
||||||
|
|
||||||
|
## Contribution Flow
|
||||||
|
|
||||||
|
This is a rough outline of what a contributor's workflow looks like:
|
||||||
|
|
||||||
|
- Create a topic branch from where you want to base your work (usually `main`).
|
||||||
|
- Make commits of logical units.
|
||||||
|
- Make sure your commit messages are in the proper format (see below).
|
||||||
|
- Push your changes to a topic branch in your fork of the repository.
|
||||||
|
- Make sure the tests pass, and add any new tests as appropriate.
|
||||||
|
- Submit a pull request to the original repository.
|
||||||
|
|
||||||
|
Thanks for your contributions!
|
||||||
|
|
||||||
|
### Generated Files
|
||||||
|
|
||||||
|
All `.yaml` files in the `/manifests` folder are generated via
|
||||||
|
[Jsonnet](https://jsonnet.org/). Contributing changes will most likely include
|
||||||
|
the following process:
|
||||||
|
|
||||||
|
1. Make your changes in the respective `*.jsonnet` or `*.libsonnet` file.
|
||||||
|
2. Commit your changes (This is currently necessary due to our vendoring
|
||||||
|
process. This is likely to change in the future).
|
||||||
|
3. Generate dependent `*.yaml` files: `make generate`
|
||||||
|
4. Commit the generated changes.
|
||||||
|
|
||||||
|
### Format of the Commit Message
|
||||||
|
|
||||||
|
We follow a rough convention for commit messages that is designed to answer two
|
||||||
|
questions: what changed and why. The subject line should feature the what and
|
||||||
|
the body of the commit should describe the why.
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts: add the test-cluster command
|
||||||
|
|
||||||
|
this uses tmux to setup a test cluster that you can easily kill and
|
||||||
|
start for debugging.
|
||||||
|
|
||||||
|
Fixes #38
|
||||||
|
```
|
||||||
|
|
||||||
|
The format can be described more formally as follows:
|
||||||
|
|
||||||
|
```
|
||||||
|
<subsystem>: <what changed>
|
||||||
|
<BLANK LINE>
|
||||||
|
<why this change was made>
|
||||||
|
<BLANK LINE>
|
||||||
|
<footer>
|
||||||
|
```
|
||||||
|
|
||||||
|
The first line is the subject and should be no longer than 70 characters, the
|
||||||
|
second line is always blank, and other lines should be wrapped at 80 characters.
|
||||||
|
This allows the message to be easier to read on GitHub as well as in various
|
||||||
|
git tools.
|
||||||
15
README.md
15
README.md
@ -71,7 +71,7 @@ If you are migrating from `release-0.7` branch or earlier please read [what chan
|
|||||||
- [Authorization problem](#authorization-problem)
|
- [Authorization problem](#authorization-problem)
|
||||||
- [kube-state-metrics resource usage](#kube-state-metrics-resource-usage)
|
- [kube-state-metrics resource usage](#kube-state-metrics-resource-usage)
|
||||||
- [Error retrieving kube-proxy metrics](#error-retrieving-kube-proxy-metrics)
|
- [Error retrieving kube-proxy metrics](#error-retrieving-kube-proxy-metrics)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](CONTRIBUTING.md)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
@ -777,19 +777,6 @@ By default, kubeadm will configure kube-proxy to listen on 127.0.0.1 for metrics
|
|||||||
2. If the k8s cluster is already up and running, we'll have to modify the configmap kube-proxy in the namespace kube-system and set the metricsBindAddress field. After this kube-proxy daemonset would have to be restarted with
|
2. If the k8s cluster is already up and running, we'll have to modify the configmap kube-proxy in the namespace kube-system and set the metricsBindAddress field. After this kube-proxy daemonset would have to be restarted with
|
||||||
`kubectl -n kube-system rollout restart daemonset kube-proxy`
|
`kubectl -n kube-system rollout restart daemonset kube-proxy`
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
All `.yaml` files in the `/manifests` folder are generated via
|
|
||||||
[Jsonnet](https://jsonnet.org/). Contributing changes will most likely include
|
|
||||||
the following process:
|
|
||||||
|
|
||||||
1. Make your changes in the respective `*.jsonnet` file.
|
|
||||||
2. Commit your changes (This is currently necessary due to our vendoring
|
|
||||||
process. This is likely to change in the future).
|
|
||||||
3. Update the pinned kube-prometheus dependency in `jsonnetfile.lock.json`: `jb update`
|
|
||||||
4. Generate dependent `*.yaml` files: `make generate`
|
|
||||||
5. Commit the generated changes.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Apache License 2.0, see [LICENSE](https://github.com/prometheus-operator/kube-prometheus/blob/main/LICENSE).
|
Apache License 2.0, see [LICENSE](https://github.com/prometheus-operator/kube-prometheus/blob/main/LICENSE).
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user