Few changes to CONTRIBUTING and README

NicolasCARPi commented 8 months ago

Hello,

Here are a few changes that I believe would improve slightly the DX:

make CONTRIBUTING.md a real page instead of a redirection to a section of the README. Bring back things from the README that really belong in the dev doc.
make the links to packages in README relative to the repo (previous links were all 404, too). It makes the links work in forks.

I don't know what to do with this auto changelog thing, sorry. But if there is a special git command to avoid generating it, we'll want to add it to the freshly improved CONTRIBUTING documentation ;) IMHO it should only run before making a release, no?

tnrich commented 6 months ago

Hi @NicolasCARPi sorry I didn't see this one till now. I've updated the PR template to include an @tnrich tag so I'll hopefully be notified of incoming PRs sooner in the future. Thanks for your changes, they look good. I'll poke around to see if I can get the changelog to only be run on version bumps.

Cheers!

NicolasCARPi commented 6 months ago

Hello,

Thanks for merging. Why don't you use the "Watch" function of github? Seems getting notifications for all activity on this repo make sense, no?

tnrich commented 6 months ago

@NicolasCARPi I wasn't sure where that toggle lived, thanks! I've updated my watch status to All Activity.

Cheers!

TeselaGen / tg-oss

Few changes to CONTRIBUTING and README #53