CONTRIBUTING.md

Contributing to Hardware API

Thanks for taking the time to contribute to Hardware API.

Here are the guidelines for contributing to the development of Hardware API. These are guidelines, not hard and fast rules; but please exercise judgement. Feel free to propose changes to this document.

Hardware API is hosted and managed on GitHub. If you're not familiar with how GitHub works, their quickstart documentation provides an excellent introduction to all the tools and processes you'll need to know.

Pull requests are merged with rebasing, so please make sure your commits are atomic and well described. We generally follow the specification of Conventional Commits.

For server-specific contribution guidelines, refer to the server contribution guide.

For client-specific contribution guidelines, refer to the client contribution guide.

Pre-requisites

Before you can begin, you will need to:

• Read and agree to abide by our Code of Conduct.
• Create (or have) a GitHub account.
• Sign the Canonical contributor license agreement. This grants us your permission to use your contributions in the project.

Local Deployment

• Install Docker and set up permissions for the server deployment. For further information on the server deployment, refer to the server contribution guide.
• Install rust and cargo for client deployment. For further information on the client deployment, refer to the client contribution guide.

To run the server locally, make sure that no other application is using port 8080.