Code of Conduct
Popper adheres to the code of conduct posted in this repository. By participating or contributing to Popper, you're expected to uphold this code. If you encounter unacceptable behavior, please immediately email us.
Contributing CLI features
To contribute new CLI features:
- Add a new issue describing the feature.
- Fork the official repo and implement the issue on a new branch.
- Add tests for the new feature. We test the
popperCLI command using Popper itself. The Popper pipeline for testing the
poppercommand is available here.
- Open a pull request against the
Contributing example pipelines
We invite anyone to implement (and document) Popper pipelines demonstrating the use of a DevOps tool, or how to apply Popper in a particular domain. Implementing a new example is done in two parts.
Implement the pipeline
Once a pipeline has been implemented, it needs to be uploaded to
github, gitlab or any other repo publicly available. We use the
organization https://github.com/popperized to host examples
developed by the Popper team and collaborators. Pipelines on this
organization are available by default to the
command, so users can add it easily to their repos (using
popper add). To add a repository containing one or more pipelines to this
organization, please first create the repository on GitHub under an
organization you own and then do one of the following:
- Transfer ownership of the repo to the
- Open an issue requesting the repository to be forked or mirrored. NOTE: forks and mirrors need to be updated manually in order to reflect changes done on the base/upstream repository.
Document the pipeline
We encourage contributors to document pipelines by adding them to our list of examples. To add new documentation: