add initial changelog.md and contributing.md - #34
Merged
Conversation
Added section for project maintainers and reorganized contributing guidelines.
Collaborator
Author
|
In this I am claiming we will start using semantic versioning (see link in changelog). I believe this is a good choice and a common guideline for software. If that is the case this should be v1.1.0 as the changes (fixed atoms, stepsize) would fall into the minor category. That said, we also can do whatever we want. Maybe shooting for semantic versioning and closer compliance with keep a changelog format are goals for the near future? |
Collaborator
|
I'm happy to maintain the changelog and use semantic versioning. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add CHANGELOG.md and CONTRIBUTING.md; update README
Summary
Closes #33
CHANGELOG.mdfollowing the Keep a Changelog format with semantic versioning. Includes an[Unreleased]section and entries for v1.0.0 and v1.0.1.CONTRIBUTING.mdwith a full developer onboarding guide covering Pixi environment setup, all availablepixirun tasks (fmt,lint,types,test,coverage,docs,all),pre-commitinstallation and usage, and a contribution workflow. Asks contributors to open an issue or contact the maintainer before opening a PR.README.mdwith two new badges (Contributing, Changelog) and a## Contributingsection linking to both new files.