CONTRIBUTING.md

Contributing to Orkestra

Welcome to Orkestra! We would love to accept your patches and contributions to this project.

Here is how you can help:

• Report or fix bugs.
• Add or propose new features.
• Improve our documentation.

Resources

• Website: https://azure.github.io/orkestra/
• Documentation: https://azure.github.io/orkestra/api.html
• Developer's Guide: https://azure.github.io/orkestra/developers.html
• Discussion forum: https://github.com/Azure/orkestra/discussions
• Azure Orkestra Slack: Join the Azure Orkestra Slack

Pull Request Checklist

Before sending your pull requests, make sure you do the following:

• Read this contributing guide.
• Read the Code of Conduct.
• Run the tests.
• Run make prepare-for-pr. For details, see Prepare Code for PR section.

How to become a contributor

Contributor License Agreement

Most contributions to this project require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Finding something to work on

If you want to write some code, but don't know where to start or what you might want to do, take a look at the Good First Issue label.

Developing Orkestra

Follow the Developer's Guide for a full set of instructions to get started with building, running, and debugging Orkestra.

Running tests

For a full set of instructions to run tests, follow the testing & debugging section of Developer's Guide. For some tips, you can run tests with the following make target.

make clean && make dev && make test

Prepare Code for PR

Before submitting a PR, run the following make target.

make prepare-for-pr

This will perform following checks:

• Examine Go source code and report suspicious constructs.
• Format Go source code.
• Update API docs if applicable.

Security

For instructions on reporting security issues and bugs, please see security guide.

Support

For questions about building, running, or troubleshooting, start with the Developer's Guide, and work your way through the process that we've outlined. If that doesn't answer your question(s), try to post on Discussion tab or if you think you found a bug, please file an issue.

If you still have question(s), join the Azure Orkestra Slack and someone will help you get answer(s) to your question(s).