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

Move change log from README.md to CHANGELOG.md #446

Closed
johlju opened this issue Sep 29, 2019 · 4 comments · Fixed by #480
Closed

Move change log from README.md to CHANGELOG.md #446

johlju opened this issue Sep 29, 2019 · 4 comments · Fixed by #480
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub hacktoberfest See https://hacktoberfest.digitalocean.com/

Comments

@johlju
Copy link
Member

johlju commented Sep 29, 2019 •
edited
Loading

We should move the change log out from the README.md and into a separate file CHANGELOG.md.

See example https://github.com/PowerShell/ActiveDirectoryDsc/blob/dev/CHANGELOG.md

Also in the README.md we should add a change log section. See example https://github.com/PowerShell/ActiveDirectoryDsc#change-log
@johlju johlju added documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub hacktoberfest See https://hacktoberfest.digitalocean.com/ help wanted The issue is up for grabs for anyone in the community. labels Sep 29, 2019
@devevignesh
Copy link
Contributor

I would like to claim this. Thanks

@johlju
Copy link
Member Author

johlju commented Sep 29, 2019

@devevignesh it's yours, looking forward to the PR! 😄

@johlju johlju added in progress The issue is being actively worked on by someone. and removed help wanted The issue is up for grabs for anyone in the community. labels Sep 29, 2019
@johlju
Copy link
Member Author

johlju commented Sep 29, 2019

We must also update the first entry in the file https://github.com/PowerShell/xWebAdministration/blob/dev/.github/PULL_REQUEST_TEMPLATE.md. It should say that we should update the Unreleased section in CHANGELOG.md.

@devevignesh devevignesh mentioned this issue Sep 29, 2019
Merged
9 tasks
@devevignesh
Copy link
Contributor

@johlju Opened PR for your review. Thanks.

johlju pushed a commit that referenced this issue Sep 30, 2019
@devevignesh @johlju
Moved change log from README.md (#480)
a41f18a 
- Changes to xWebAdministration
  - Moved change log from README.md to a separate CHANGELOG.md (issue #446).
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Sep 30, 2019
gstorme pushed a commit to gstorme/xWebAdministration that referenced this issue Feb 14, 2020
@devevignesh
Moved change log from README.md (dsccommunity#480)
3c2b71a 
- Changes to xWebAdministration
  - Moved change log from README.md to a separate CHANGELOG.md (issue dsccommunity#446).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub hacktoberfest See https://hacktoberfest.digitalocean.com/
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update CHANGELOG.md devevignesh/xWebAdministration
2 participants
@johlju @devevignesh