Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.81 KB

Contributing to NeuronAPI

First off, thank you for considering contributing to NeuronAPI! We appreciate your time and effort in helping improve the project. Below is a guide on how you can contribute.

How to Contribute

1. Fork the Repository

Fork the repository from NeuronAPI to your GitHub account.

2. Create a Branch

Create a new branch for your feature, bug fix, or enhancement:

git checkout -b feature/my-new-feature

3. Make Changes

Make your changes in your local repository. Be sure to:

  • Follow the project's existing code style.
  • Write tests for any new functionality.
  • Ensure that the code passes all tests.

4. Commit Changes

Write clear and concise commit messages explaining your changes:

git commit -m "Add new feature to X"

5. Submit a Pull Request

Push your changes and submit a pull request to the main branch of NeuronAPI:

git push origin feature/my-new-feature
  • Open a pull request on GitHub and explain the changes you’ve made.
  • Include any relevant issues this PR addresses (use Fixes #issue_number if applicable).

Code Style

  • Follow the existing code structure and formatting.
  • For Python, use PEP 8 standards.

Reporting Bugs

If you find a bug, please open an issue using the Bug Report template.

Suggesting Enhancements

We’re open to new ideas! To suggest an enhancement, use the Feature Request template.

Join the Discussion

Feel free to participate in discussions under the Discussions tab to share ideas and suggestions.

Contributor License Agreement (CLA)

https://cla-assistant.io/Doblier/NeuronAPI

Thank you again for your contribution!