Welcome to NanoTrack! We appreciate your interest in contributing to our project. This guide will help you get started with the contribution process.
Please note that we have a Code of Conduct, and we expect all contributors to adhere to it. By participating in NanoTrack, you agree to abide by its terms.
There are several ways to contribute to NanoTrack:
If you encounter any bugs or issues while using NanoTrack, please help us by reporting them. Provide as much detail as possible, including a clear description, steps to reproduce the issue, and any relevant screenshots or error messages.
If you have ideas for new features or enhancements to existing features, please share them by creating an enhancement request. Describe your proposed improvement and its potential impact on NanoTrack.
If you are interested in contributing code to NanoTrack, follow these steps:
-
Fork the NanoTrack repository to your own GitHub account.
-
Clone your forked repository to your local machine.
git clone https://github.com/your-username/nanotrack.git
-
Create a new branch for your changes.
git checkout -b feature/your-feature-name
-
Make your changes, following the code style guidelines.
-
Commit your changes with clear and concise commit messages.
git commit -m "Add feature: your feature description" -
Push your changes to your forked repository.
git push origin feature/your-feature-name
-
Create a pull request (PR) to the NanoTrack repository. Include a detailed description of your changes and any relevant information.
We will review your PR and provide feedback as needed. Once approved, your changes will be merged into the main NanoTrack repository.
To set up a development environment for NanoTrack, please follow the instructions in the Development Setup Guide.
When submitting a pull request, please ensure that:
- Your code follows the code style guidelines.
- You have included relevant tests for your changes.
- Your commits are clear and concise, with descriptive commit messages.
- You have documented any new features or changes in the project's documentation.
We follow a consistent code style to maintain readability and code quality. Please adhere to the code style guidelines outlined in the Code Style Guide.
By contributing to NanoTrack, you agree that your contributions will be licensed under the MIT License.