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-contributorschannel 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.
Reviewing PRs¶
Anybody can review a PR. If you are in a designated role, add yourself as an "Assignee" to a PR if you plan to lead the review. If you are a Reviewer or below, then once you have approved a PR, request a review from one or more Approvers and above.
Triaging Bugs¶
New bugs need to be triaged to identify the highest priority ones. Any Member can triage bugs.
Apply the labels P0, P1, P2, and P3, where P0 is highest priority and needs immediate attention, followed by P1, P2, and then P3.
If there's a new P0 bug, notify the #argo-wf-contributors Slack channel.
Any bugs with >= 5 "👍" reactions should be labeled at least P1.
Any bugs with 3-4 "👍" reactions should be labeled at least P2.
Bugs can be sorted by "👍".
If the issue is determined to be a user error and not a bug, remove the type/bug label (and the type/regression label, if applicable) and replace it with the type/support label.
If more information is needed from the author to diagnose the issue, then apply the problem/more information needed label.
Please only assign issues to members. New contributors are encouraged to work on a PR directly without being assigned.
Staleness¶
Only issues and PRs that have the problem/more information needed label will be considered for staleness.
If the author does not respond timely to a request for more information, the issue or PR will be automatically marked with the problem/stale label and a bot message.
Subsequently, if there is still no response, it will be automatically closed as "not planned".
See the Stale Action configuration for more details.
Automated actions¶
As a member (see roles) of the argo-project you can use the following comments on PRs to trigger actions:
/retest- re-run any failing test cases/test- trigger the full test suite. Only use this for PRs where the test suite has not automatically triggered - this is almost always wasteful and will not make things pass that/retestdoesn't pass./cherry-pick <branchname>- will attempt to cherry-pick this commit after it has been merged to the target branch. This can be used prior to merging and the PR will be created after the merge, or commented after merging for an immediate attempt.
Sustainability Effort¶
Argo Workflows is seeking more Reviewers and Approvers to help keep it viable. Please see Sustainability Effort for more information.