Contributing¶
How To Provide Feedback¶
Please raise an issue in Github.
Code of Conduct¶
See CNCF Code of Conduct.
Community Meetings (monthly)¶
A monthly opportunity for users and maintainers of Workflows and Events to share their current work and hear about what’s coming on the roadmap. Please join us! For Community Meeting information, minutes and recordings please see here.
Contributor Meetings (twice monthly)¶
A weekly opportunity for committers and maintainers of Workflows and Events to discuss their current work and talk about what’s next. Feel free to join us! For Contributor Meeting information, minutes and recordings please see here.
How To Contribute¶
We're always looking for contributors.
- Documentation - something missing or unclear? Please submit a pull request!
- Code contribution - investigate a good first issue , or anything not assigned.
- You can work on an issue without being assigned.
- Join the
#argo-contributors
channel on our Slack.
Running Locally¶
To run Argo Workflows locally for development: running locally.
Committing¶
See the Committing Guidelines.
Dependencies¶
Dependencies increase the risk of security issues and have on-going maintenance costs.
The dependency must pass these test:
- A strong use case.
- It has an acceptable license (e.g. MIT).
- It is actively maintained.
- It has no security issues.
Example, should we add fasttemplate
, view the Snyk report:
Test | Outcome |
---|---|
A strong use case. | ❌ Fail. We can use text/template . |
It has an acceptable license (e.g. MIT) | ✅ Pass. MIT license. |
It is actively maintained. | ❌ Fail. Project is inactive. |
It has no security issues. | ✅ Pass. No known security issues. |
No, we should not add that dependency.
Test Policy¶
Changes without either unit or e2e tests are unlikely to be accepted. See the pull request template.
Contributor Workshop¶
Please check out the following resources if you are interested in contributing:
- 90m hands-on contributor workshop.
- Deep-dive into components and hands-on experiments.
- Architecture overview.