Guidelines for contributing

marl / crepe

CREPE: A Convolutional REpresentation for Pitch Estimation -- pre-trained model (ICASSP 2018)

https://marl.github.io/crepe/

MIT License

1.12k stars 160 forks source link

Guidelines for contributing #58

Open justinsalamon opened 4 years ago

justinsalamon commented 4 years ago

We should add guidelines + templates for posting issues and contributing code.

There are examples for both in Librosa we could work off of: https://github.com/librosa/librosa/blob/master/CONTRIBUTING.md

@jongwook I'm happy to put this together if it sounds good to you?

jongwook commented 4 years ago

Sure! One exception is that I don't want to strictly adhere to the 80-column limit of PEP8 - we might want to use black which defaults to 88, or use PyCharm's default of 120. (or drop the formatting guidelines altogether for now)

justinsalamon commented 4 years ago

OK cool, I'll try to get to this some time soon. I agree about the character limit, 80 seems harsh given today's screens, I like black so happy to use that.