-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This wiki gathers all the essential resources for contributing, developing, and maintaining packages within the control-toolbox ecosystem.
Whether you are a new contributor, a developer, or a maintainer, this documentation will guide you step by step through setup, contribution workflow, and release procedures.
Learn how to contribute efficiently and collaborate on repositories within the ecosystem.
- 👉 Contribution Guidelines
Step-by-step explanation of the contribution process:- Understanding issues, branches, and pull requests
- Setting up a draft PR
- Requesting reviews
- Best practices for clean commits
Everything you need to set up your Julia development environment.
-
Dev setup
Learn how to:- Configure your local and official registries
- Add and develop Julia packages
- Distinguish between developer and user roles
- Update dependencies
The technical reference for developing within the ecosystem.
-
Developer guide
Covers:- Cloning a repository
- Installing and configuring VSCode
- Running unit tests
- Building documentation with Documenter.jl
Guidelines for releasing and registering packages.
-
Make a release
Includes:- Semantic versioning rules
- How to tag and register in the General registry
- How to register with LocalRegistry.jl
Additional notes, references, and advanced developer topics.
| Section | Description |
|---|---|
| 💡 Contribution Guidelines | How to contribute and collaborate on repositories |
| 🧰 Dev setup | Configure your development environment |
| 🧑💻 Developer guide | Core development and documentation workflow |
| 🚀 Make a release | Release and registry management |
| 🧩 Misc | Other useful notes and resources |
📚 Tip: If you are new to this ecosystem, start with the
➡️ Contribution Guidelines
and then move on to the Developer Guide.