Skip to content
This repository was archived by the owner on Dec 2, 2020. It is now read-only.

Commit 060b887

Browse files
author
Sam Spencer
committed
Added Versioning Guidelines
Added guidelines governing how to increment the version number when contributing to the project, and how to handle API deprecation and removal.
1 parent 88cc8a4 commit 060b887

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ The best way to contribute changes (e.g. a great idea, a new feature, bug fixes,
3333
#### Code Guidelines
3434
Before submitting any code changes, read over the code / syntax guidelines to make sure everything you write matches the appropriate coding style. The [Objective-C Coding Guidelines](https://github.com/github/objective-c-conventions) are available on GitHub.
3535

36+
#### Versioning Guidelines
37+
It is crucial that all contributions to this project adhere to [semantic versioning](http://semver.org). Ther version format should always follow the X.Y.Z format. Breaking changes to the public API increment the X value. Internal changes, API deprecation, bug fixes, etc. warrant an increment to the Y value. Bug fixes, patches, documentation updates, etc. are cause for an increment to the Z value.
38+
39+
Removing old APIs should use the following process:
40+
1. Deprecate the API, update documentation, and provide internal support and warnings for the deprecated API (so as to alert developers and to smoothly transition to new APIs without cause errors or bugs).
41+
2. Release a new minor version including the deprecated API
42+
3. When the next major version is released, remove the API entirely. Reflect the changes in the documentation.
43+
3644
#### Documentation Guidelines
3745
Document the changes you make. Only fundamental documentation is written in the `Readme.md` (e.g. setup, installation, data source, and delegation). Full documentation is written on the [wiki](https://github.com/Boris-Em/BEMSimpleLineGraph/wiki). There's a lot of work left to do on the [wiki](https://github.com/Boris-Em/BEMSimpleLineGraph/wiki), and any help **writing documentation for the wiki is greatly appreciated**.
3846

0 commit comments

Comments
 (0)