Skip to content

[#32] Add a Changelog file #39

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
Merged
merged 10 commits into from
Sep 13, 2022
Merged

[#32] Add a Changelog file #39

merged 10 commits into from
Sep 13, 2022

Conversation

Allstreamer
Copy link
Collaborator

  • Added CHANGELOG.md based on Keep a Changelog template
  • Added Dev-branch changelogs

@Allstreamer Allstreamer added the documentation Improvements or additions to documentation label Aug 18, 2022
@Allstreamer Allstreamer self-assigned this Aug 18, 2022
@Allstreamer Allstreamer requested a review from John15321 August 18, 2022 06:20
@John15321
Copy link
Contributor

Technically we had our 0.0.1 release https://crates.io/crates/rust-pip so we have to that into account somehow

@Allstreamer
Copy link
Collaborator Author

I'll include the main branch commits as 0.0.1

@John15321 John15321 changed the title [32] Add a Changelog file [#32] Add a Changelog file Aug 18, 2022
@Allstreamer
Copy link
Collaborator Author

You really pay attention to the smallest details

John15321
John15321 reviewed Aug 18, 2022
View reviewed changes
@John15321
Copy link
Contributor

Markdown has its own formatting guidelines and given that it's a markup language that is whitespace sensitive it's important to make sure that it's formatted. If you are using VSCode you can use the markdownlint extension for that. But now that I think of it we could use a CI job to check that our markdown docs are properly formatted. You can make a task about it and even add it in this PR if you want:
image

John15321
John15321 reviewed Aug 18, 2022
View reviewed changes
@John15321 John15321 linked an issue Aug 23, 2022 that may be closed by this pull request
Add a CHANGELOG file #32
Closed
John15321
John15321 reviewed Aug 23, 2022
View reviewed changes
@Allstreamer @John15321
Created CHANGELOG.md
48b62c6 
- Basic Changelog template + Devbranch changes
@Allstreamer @John15321
Update CHANGELOG.md
a417e11 
- Attempting to fix commit links
@Allstreamer @John15321
Removed Commit Links
9aa8caf
@Allstreamer @John15321
Update CHANGELOG.md
98f414c 
Changed created to added
@Allstreamer @John15321
Update CHANGELOG.md
8d94256 
- Created `0.0.1` Release
- Made CLI changes more explicit
@Allstreamer @John15321
Moved Unreleased to top
26e3db5
@Allstreamer @John15321
Fixed Categorys
6a520f2
@Allstreamer @John15321
Formated CHANGELOG.md
098d999 
- Formatted CHANGELOG.MD
- Added linting rules
@Allstreamer @John15321
Moved Changelog Creation message
1a21cf3 
- Moved Changelog Creation message to its own docs section
@Allstreamer @John15321
Update CHANGELOG.md
3d9ca5d 
- Added Links to commits that had pull requests
@John15321 John15321 force-pushed the 32-add-a-changelog-file branch from 12ec933 to 3d9ca5d Compare September 13, 2022 22:18
@John15321 John15321 self-requested a review September 13, 2022 22:27
John15321
John15321 approved these changes Sep 13, 2022
View reviewed changes
Copy link
Contributor

@John15321 John15321 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

git gut

@John15321 John15321 merged commit 480cf4a into develop Sep 13, 2022
@John15321 John15321 deleted the 32-add-a-changelog-file branch September 13, 2022 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cnpryer cnpryer cnpryer left review comments

@John15321 John15321 John15321 approved these changes

Assignees

@Allstreamer Allstreamer

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
📃 Documentation
Development

Successfully merging this pull request may close these issues.

Add a CHANGELOG file
3 participants
@Allstreamer @John15321 @cnpryer