Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Keeping a CHANGELOG.md #129

Open
tallamjr opened this issue May 9, 2019 · 1 comment
Open

Keeping a CHANGELOG.md #129

tallamjr opened this issue May 9, 2019 · 1 comment
Assignees
@tallamjr
Labels
documentation Updates to documentation required low priority A "nice-to-have" low priority issue than can be tackled anytime. No rush for implementation

Comments

@tallamjr
Copy link
Collaborator

tallamjr commented May 9, 2019

It would be beneficial to the developers as well as futures users of snmachine to see the API changes documented in a CHANGELOG.md file.

This would identify any breaking changes or upcoming breaking changes to the API as well as keep a record of minor changes that have been made.

Although potentially overkill, an example for such a file can be found at : https://keepachangelog.com/en/1.0.0/
@tallamjr tallamjr self-assigned this May 9, 2019
@tallamjr tallamjr added documentation Updates to documentation required low priority A "nice-to-have" low priority issue than can be tackled anytime. No rush for implementation labels May 9, 2019
tallamjr added a commit that referenced this issue May 9, 2019
@tallamjr
Major updates to CONTRIBUTING.md file
c091e6c 
In addition to Code Style section, further subsections have been added
such as:

	* Creating an Issue
	* Submitting a Pull Request
	* Running Tests Locally
	* Package Versioning]

Some sections anticipate adoption of certain practises that have not
been implemented yet, such as CHANGELOG, but this should be in place in
due course. Therefore this commit links to #129

Closes #127
tallamjr added a commit that referenced this issue May 9, 2019
@tallamjr
Major updates to CONTRIBUTING.md file
400a9cb 
In addition to Code Style section, further subsections have been added
such as:

	* Creating an Issue
	* Submitting a Pull Request
	* Running Tests Locally
	* Package Versioning

Some sections anticipate adoption of certain practises that have not
been implemented yet, such as CHANGELOG, but this should be in place in
due course. Therefore this commit links to #129

Closes #127
@tallamjr tallamjr mentioned this issue May 9, 2019
Merged
@rbiswas4
Copy link
Member

rbiswas4 commented Jun 2, 2019

We should start maintaining this from a fixed point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tallamjr tallamjr

Labels
documentation Updates to documentation required low priority A "nice-to-have" low priority issue than can be tackled anytime. No rush for implementation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rbiswas4 @tallamjr