CONTRIBUTING.md

Contributing to Device Registry Microservice

Thank you for considering contributing to the Device Registry microservice! We appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

1. Fork the Repository

Start by forking the repository on GitHub:

1. Navigate to the AirQo API repository.
2. Click on the Fork button at the top right corner of the page.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/your-username/AirQo-api.git

Replace your-username with your GitHub username.

3. Navigate to the Microservice Directory

Before proceeding with any contributions, navigate to the Device Registry microservice directory:

cd AirQo-api/src/device-registry

4. Create a New Branch

Before making any changes, create a new branch:

git checkout -b feature/your-feature-name

5. Make Your Changes

Make your changes in the codebase. Ensure that you follow the project's coding style and conventions.

6. Run Tests

Make sure to run tests to verify that your changes do not break any existing functionality:

npm test

7. Commit Your Changes

Commit your changes with a clear and descriptive commit message:

git commit -m "Add feature: description of your feature"

8. Push Your Changes

Push your changes back to your forked repository:

git push origin feature/your-feature-name

9. Create a Pull Request

Navigate to the original repository where you want to submit your changes. Click on Pull Requests, then click on New Pull Request. Select your branch and submit the pull request.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

Questions or Issues?

If you have any questions or issues, feel free to open an issue in the repository or reach out directly.

Thank you for contributing!