Skip to content

Contributing

Thank you for your interest in Spoor. There are several ways to get involved in Spoor's development.

Provide feedback

Please report an issue on GitHub if you find something to improve. For example:

  • Spoor crashes or you encounter a bug.
  • The documentation is incomplete or unclear.
  • An error message could be improved.

Security

Please do not report security vulnerabilities through public GitHub issues. Instead, report them to the Microsoft Security Response Center. Details.

Contribute code

All development happens on GitHub. Both core team members and external contributors submit pull requests which go through the same review process.

The most helpful contributions fix bugs, improve performance, or add features (as opposed to stylistic or "gardening" changes). Test and document your work.

When you're read to roll up your sleeves and start coding, check out the development setup guide.

Style guide

Follow Spoor's style guide when writing code.

Contributor License Agreement

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

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

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.