Skip to content

Contributing to PicoCore

Thank you for considering contributing to PicoCore! 🎉 We welcome contributions of all kinds — bug fixes, features, documentation, or even just sharing feedback.

How to Contribute

1. Fork & Clone

  • Fork the repository on GitHub.
  • Clone your fork locally:
git clone https://github.com/<your-username>/PicoCore.git
cd PicoCore

2. Create a Branch

git checkout -b feature/my-new-feature

3. Make Your Changes

  • Implement your feature or fix.
  • Add/update tests where appropriate.
  • Make sure your code is formatted and linted.

4. Commit & Push

git commit -m "Add my new feature"
git push origin feature/my-new-feature

5. Open a Pull Request

  • Go to the original repository.
  • Open a Pull Request (PR) from your branch.
  • Fill in the PR template and describe your changes.

Code Style Guidelines

  • Use PEP8 for Python code.
  • Keep functions and classes small and focused.
  • Add docstrings and comments where needed.

Reporting Issues

If you find a bug or have a feature request:

  • Open an issue in GitHub Issues.
  • Provide as much detail as possible (steps to reproduce, logs, screenshots, etc.).

Documentation Contributions

Improving docs is just as valuable as writing code! You can:

  • Fix typos or grammar.
  • Expand examples.
  • Add tutorials or guides.

The documentation is built using MkDocs Material. To build locally:

pip install mkdocs-material
mkdocs serve

License

By contributing, you agree that your contributions will be licensed under the same license as this project (see LICENSE).