2023-07-25 17:00:05 +08:00
|
|
|
# Contributing
|
|
|
|
|
|
2024-04-09 18:54:49 +08:00
|
|
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
|
|
|
|
email, or any other method with the owners of this repository before making a change.
|
2023-07-25 17:00:05 +08:00
|
|
|
|
2024-04-09 18:54:49 +08:00
|
|
|
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
2023-07-25 17:00:05 +08:00
|
|
|
|
2024-04-09 18:54:49 +08:00
|
|
|
## Any contributions you make will be under AGPL
|
2023-07-25 17:00:05 +08:00
|
|
|
|
2024-04-09 18:54:49 +08:00
|
|
|
This software is licensed under the Affero General Public License (AGPL). Any contributions made to
|
|
|
|
|
this project will be under this license. Before any contributions can be made, contributors are
|
|
|
|
|
required to sign a Contributor License Agreement (CLA). The purpose of the agreement is to clarify
|
|
|
|
|
and document the rights granted by contributors to us.
|
2023-07-25 17:00:05 +08:00
|
|
|
|
2024-04-09 18:54:49 +08:00
|
|
|
## Pull Request Process
|
2023-07-25 17:00:05 +08:00
|
|
|
|
2024-04-09 18:54:49 +08:00
|
|
|
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
|
|
|
|
|
build.
|
|
|
|
|
2. Update the README.md with details of changes to the interface, this includes new environment
|
|
|
|
|
variables, exposed ports, useful file locations and container parameters.
|
|
|
|
|
3. Increase the version numbers in any examples files and the README.md to the new version that this
|
|
|
|
|
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
|
|
|
|
|
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
|
|
|
|
|
do not have permission to do that, you may request the second reviewer to merge it for you.
|
2023-07-25 17:00:05 +08:00
|
|
|
|
2024-04-09 18:54:49 +08:00
|
|
|
## Code of Conduct
|
2023-07-25 17:00:05 +08:00
|
|
|
|
2024-04-09 18:54:49 +08:00
|
|
|
We as members, contributors, and leaders pledge to make participation in our community a harassment-free
|
|
|
|
|
experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex
|
|
|
|
|
characteristics, gender identity and expression, level of experience, education, socio-economic status,
|
|
|
|
|
nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
|
|
|
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive,
|
|
|
|
|
and healthy community.
|
|
|
|
|
|
|
|
|
|
You can read the full Code of Conduct [here](https://github.com/stalwartlabs/.github/blob/main/CODE_OF_CONDUCT.md).
|
