Skip to main content

Contributing

You can read the contributing guide in the official GitHub repository.

Welcome

Everyone is welcome to contribute code via pull requests, to file issues on GitHub, to help triage, reproduce, or fix bugs that people have filed, to add to our documentation, or to help out in any other way.

We can grant commit access (which includes full rights to the issue database, such as being able to edit labels) to people who have gained our trust and demonstrated a commitment to ClusterFactory.

Helping out in the issue database

Triage is the process of going through bugs and determining if they are valid, finding out how to reproduce them, catching duplicate reports, and generally making our issues list useful for our engineers.

If you want to help us triage, you are very welcome to do so!

Quality Assurance

One of the most useful tasks, closely related to triage, is finding and filing bugs. Testing beta releases, looking for regressions, creating test cases, adding to our test suites, and other work along these lines can drive the quality of the product up. Creating tests that increase our test coverage, writing tests for issues others have filed, all these tasks are really valuable contributions to open source projects.

Documentation

Another great area to contribute is sample code and API documentation. Most of the documentation is written inside the web directory. Feel free to add diagrams and sample code to our documentation!

The argo directory is also an example directory. Feel free to add new applications or modify ours!