✔️🎉 Let's make code better together - Thanks for taking the time to contribute! 🎉✔️
The following is a set of guidelines for contributing to 0x0I Container files, which are hosted under the 0x0I developer account on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
For general information and guidelines for contributing to these Containerfiles and the Open Containers Initiative community, see the community page.
Table of Contents
All PRs are welcome! 👍 The following guidelines and CI pipeline are provided for validating container functionality and avoiding regressions for each submitted request.
Note: to build and test this container/image, a working container runtime/engine (e.g. docker or podman) is necessary.
| Step | Description | Dependencies | Command |
|---|---|---|---|
🔧 testing |
Using the Goss testing framework, testing of this container file should be executed prior to PR submission to validate new modifications and identify/prevent regressions. | N/A | make test |
🚥 Continuous Integration (CI) |
Automatic E2E testing of this role is accomplished leveraging the Circle-CI test infrastructure platform and is executed on each pull request. Requests should not be merged unless all tests pass or the community approves otherwise. | N/A | see .circle.yml for additional details |
New GitHub issues can be opened and tracked in a similar fashion as with most Github repositories by making use of the standard Github issue management facilities.
Reference the following issue reporting guide for more details:
| Issue Type | Description |
|---|---|
⬆️ :enhancement: |
Feature requests. |
🐛 :bug: |
Confirmed bugs or reports that are very likely to be bugs. |
❓ :question: |
Questions about usage and operations (e.g. how do I do X). |
👓 💗:feedback: |
General feedback regarding the project. |
Reference this repository's wiki to visualize the project roadmap, workflow and backlog to stay up to speed with development plans and work in progress.
See the Open Container Code of Conduct.