ethereum / py_ecc

Python implementation of ECC pairing and bn_128 and bls12_381 curve operations
MIT License
183 stars 82 forks source link

Setup towncrier to generate release notes #112

Closed tmckenzie51 closed 7 months ago

tmckenzie51 commented 3 years ago

What was wrong?

Release notes process is not automated.

How was it fixed?

Towncrier is setup in order to generate the release notes. Similar changes made as shown in the template https://github.com/ethereum/ethereum-python-project-template/pull/28#issue-302025093

Cute Animal Picture

![put a cute animal picture link inside the parentheses](https://www.thesprucepets.com/thmb/uZGpg08BIJND0nAhkUSZZgMnG1Y=/2657x2657/smart/filters:no_upscale()/GettyImages-634869043-58a6e83f5f9b58a3c918ca12.jpg)

tmckenzie51 commented 3 years ago

@pipermerriam Should I create a docs/index.rst file similar to what's present in other repos? If so, what introduction/description/quickstart information should I include? Also for docs/release_notes.rst, I put v0.1.0-alpha.1 as the first version. Is this okay?

tmckenzie51 commented 3 years ago

@pipermerriam Could you review this PR for me?