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

introduce CHANGELOG.md #1680

Merged
merged 8 commits into from
Mar 8, 2023
Merged

introduce CHANGELOG.md #1680

merged 8 commits into from
Mar 8, 2023

Conversation

ca333
Copy link

@ca333 ca333 commented Feb 25, 2023

add a chronological "living" changelog file as a index for the dev.logs

@ca333
propose change.log
685510d 
add a chronological "living" changelog file as a index for the dev.logs
@ca333 ca333 mentioned this pull request Feb 25, 2023
Closed
@onur-ozkan
Copy link
Member

onur-ozkan commented Feb 25, 2023 •
edited
Loading

Dev logs technique(it's called as news there) was copied from the Fedora Infra team where I used to work sometime ago. But I think it's better to have more standardized way which this(changelog file). I think we can get rid of dev-logs directory and put CHANGELOG.md in the project root. Changelog itself can be enough to track things, I think it's not worth to feed multiple files.

With each PR/commit, we can describe/ref the changes in changelog under the future-release topic which will be updated in the release PR. Simple to track and easy to maintain.

p.s: I suggest to start doing this from now on, current content of the changelog file is definetly not correct. Almost %50 of the changes are missing in there.

@borngraced
Copy link
Member

borngraced commented Feb 26, 2023 •
edited
Loading

Dev logs technique(it's called as news there) was copied from the Fedora Infra team where I used to work sometime ago. But I think it's better to have more standardized way which this(changelog file). I think we can get rid of dev-logs directory and put CHANGELOG.md in the project root. Changelog itself can be enough to track things, I think it's not worth to feed multiple files.

With each PR/commit, we can describe/ref the changes in changelog under the future-release topic which will be updated in the release PR. Simple to track and easy to maintain.

p.s: I suggest to start doing this from now on, current content of the changelog file is definetly not correct. Almost %50 of the changes are missing in there.

I agree wit @ozkanonur plus, think it'll be a lot nicer and easier to document! imo.

@ca333
Copy link
Author

ca333 commented Feb 26, 2023

Dev logs technique(it's called as news there) was copied from the Fedora Infra team where I used to work sometime ago. But I think it's better to have more standardized way which this(changelog file). I think we can get rid of dev-logs directory and put CHANGELOG.md in the project root. Changelog itself can be enough to track things, I think it's not worth to feed multiple files.

agreed - simplicity is the main reason why I proposed it. Most projects handle it via changelog.md - also introduced this in the dpow repo https://github.com/KomodoPlatform/dPoW/blob/master/doc/changelog.md some time ago.
With this PR I just tried to adapt/enhance your proposal.

With each PR/commit, we can describe/ref the changes in changelog under the future-release topic which will be updated in the release PR. Simple to track and easy to maintain.

p.s: I suggest to start doing this from now on, current content of the changelog file is definetly not correct. Almost %50 of the changes are missing in there.

I will modify this PR to cover ^

ref. [...] current content of the changelog file is definetly not correct. Almost %50 of the changes are missing in there. - the content was copied over from the 1.0.0-beta change-log / input from team. You can sub-PR the missing changes into the new changelog.md or wait for #1576 (comment)

@ca333 ca333 changed the title propose change.log introduce CHANGELOG.md Feb 26, 2023
@ca333 ca333 requested review from onur-ozkan and shamardy March 6, 2023 19:02
onur-ozkan
onur-ozkan previously approved these changes Mar 7, 2023
View reviewed changes
shamardy
shamardy reviewed Mar 7, 2023
View reviewed changes
Copy link
Collaborator

@shamardy shamardy left a comment •
edited
Loading

Choose a reason for hiding this comment

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

these new commits are not in the changelog:
be00363
a6f9a0e
ec6d028
b6a9c92
bf43cc8
5549d69
f32cb17

CHANGELOG.md Outdated
- enhanced logging in` spv` and `rpc_client` mods #1594
- update metrics related dep && refactoring #1312
- fix rick and morty genesis block deserialization #1647
- Include maker/taker pubkeys in MM2.db stats_swaps table #1665
Copy link
Collaborator

Choose a reason for hiding this comment

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

This PR is still open for review and has not been merged to dev or main yet.

CHANGELOG.md Outdated
- Allow passing Zcash params file path to activation request [#1538](https://github.com/KomodoPlatform/atomicDEX-API/pull/1538)
- Checksum verification of Zcash params files was added [#1549](https://github.com/KomodoPlatform/atomicDEX-API/pull/1549)
- NFT integration [#900](https://github.com/KomodoPlatform/atomicDEX-API/issues/900)
- under review stage as [r2r] NFT proof of concept implementation [#1652](https://github.com/KomodoPlatform/atomicDEX-API/pull/1652)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is still in review too

onur-ozkan
onur-ozkan previously approved these changes Mar 8, 2023
View reviewed changes
onur-ozkan
onur-ozkan previously approved these changes Mar 8, 2023
View reviewed changes
@shamardy shamardy merged commit 66c458a into dev Mar 8, 2023
@shamardy shamardy deleted the propose_change_log branch March 8, 2023 16:24
shamardy added a commit that referenced this pull request Mar 8, 2023
@ca333 @shamardy
docs: introduce CHANGELOG.md (#1680)
278b525 
* propose change.log

add a chronological "living" changelog file as a index for the dev.logs

* introduce CHANGELOG.md

* [docs] update changelog

* [docs] add changelog date/tag

* update changelog

* update date

* re-enable mac ci, add one more change log

---------

Co-authored-by: shamardy <[email protected]>
Reviewed-by: ozkanonur <[email protected]>
shamardy added a commit that referenced this pull request Mar 15, 2023
@ca333 @shamardy
docs: resolve changelog conflict (#1707)
be5503f 
* [ci] change release branch from mm2.1 to main (#1697)

* change release branch from mm2.1 to main

* replace mm2.1 to main in eth_tests

* ci: disable mac ci steps (#1701)

Reviewed-by: ozkanonur <[email protected]>

* docs: introduce CHANGELOG.md (#1680)

* propose change.log

add a chronological "living" changelog file as a index for the dev.logs

* introduce CHANGELOG.md

* [docs] update changelog

* [docs] add changelog date/tag

* update changelog

* update date

* re-enable mac ci, add one more change log

---------

Co-authored-by: shamardy <[email protected]>
Reviewed-by: ozkanonur <[email protected]>, shamardy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shamardy shamardy shamardy left review comments

@onur-ozkan onur-ozkan onur-ozkan left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ca333 @onur-ozkan @borngraced @shamardy