2b1a627ed0
Documented semver-based versioning flow - Explained usage of patch (develop), minor (x.x.x-dev), and major (x.0.0-dev) branches - Added guidance on where to submit bug fixes, new features, and breaking changes - Improves contributor clarity and aligns with current project workflow (e.g., Lime 8.2.2 -> 8.3.0-dev, 9.0.0-dev) This helps reduce confusion about where to submit changes and ensures consistency across releases.
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
How To Contribute
|
|
=================
|
|
|
|
We welcome your feedback and input in how to make Lime better!
|
|
|
|
If you are interested in discussing new features, the direction the project or how to integrate some change, please open an issue so we can talk about.
|
|
|
|
1. Fork the repository
|
|
|
|
2. Make the desired change
|
|
|
|
3. Create a pull request
|
|
|
|
|
|
You may consider creating a branch specific to the fix or improvement you wish to make, in case you have more than one that has not been accepted into the project, or to allow for item-specific changes.
|
|
|
|
It is our goal to help Lime evolve as a clean, easy-to-use (but powerful) layer for cross-platform development. Thanks for being a part of making this possible!
|
|
|
|
## Versioning and Branching Guidelines
|
|
|
|
We follow Semantic Versioning (semver): MAJOR.MINOR.PATCH.
|
|
|
|
### Patch Updates (x.x.x)
|
|
|
|
All bug fixes should be submitted to the current stable development branch (e.g., develop).
|
|
|
|
These changes are released as patch versions (e.g., 8.2.3 → 8.2.4).
|
|
|
|
### Minor Updates (x.x.0)
|
|
|
|
All new features (non-breaking) should be submitted to the next minor development branch, named x.x.x-dev.
|
|
|
|
For example, if the current version is 8.2.2, features targeting 8.3.0 should go into 8.3.0-dev.
|
|
|
|
### Major Updates (x.0.0)
|
|
|
|
Any breaking changes or major version updates must be submitted to the next major development branch, named x.0.0-dev.
|
|
|
|
For example, breaking changes intended for 9.0.0 go into 9.0.0-dev.
|