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.

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

Add contributing guidelines (borrowed from metabrainz/picard) #287

Merged
merged 2 commits into from Nov 15, 2017

Conversation

Projects
None yet
3 participants
@jwflory
Contributor

jwflory commented Nov 11, 2017

Summary

Adds basic contributing guidelines (mostly stolen from Picard a la @samj1912 ¹ ) to help newcomers contribute to ListenBrainz.

Background

I saw Picard's contributing guidelines and took those for inspiration. I added some of my own changes and additions.

Details

I tried to make this guide comprehensive for ListenBrainz. Feedback from @mayhem and @paramsingh especially welcome!


¹ @samj1912 did awesome work on the Picard contributing guidelines, seriously! They were so easy to copy and reuse. 😄 🎉 💯
² The Travis CI build is failing because of metabrainz/brainzutils-python#6, I think.

@paramsingh

This comment has been minimized.

Show comment
Hide comment
@paramsingh

paramsingh Nov 11, 2017

Member

Should we include something about writing tests for (ideally) each bugfix or new feature added?

Member

paramsingh commented Nov 11, 2017

Should we include something about writing tests for (ideally) each bugfix or new feature added?

@jwflory

This comment has been minimized.

Show comment
Hide comment
@jwflory

jwflory Nov 11, 2017

Contributor

@paramsingh Is there anything specific you want to mention there? Otherwise, I can try to add that in.

Contributor

jwflory commented Nov 11, 2017

@paramsingh Is there anything specific you want to mention there? Otherwise, I can try to add that in.

@paramsingh

This comment has been minimized.

Show comment
Hide comment
@paramsingh

paramsingh Nov 11, 2017

Member

Just a small paragraph saying something like "Try to include tests in each new pull request for bugfixes or new features. Unit tests are present alongside their respective modules and integration tests are present in the directory listenbrainz/tests/integration".

Member

paramsingh commented Nov 11, 2017

Just a small paragraph saying something like "Try to include tests in each new pull request for bugfixes or new features. Unit tests are present alongside their respective modules and integration tests are present in the directory listenbrainz/tests/integration".

@jwflory

This comment has been minimized.

Show comment
Hide comment
@jwflory

jwflory Nov 11, 2017

Contributor

@paramsingh Done! Excerpted from the commit:

Writing unit tests

Unit tests are an important part of ListenBrainz. It helps make it easier for
developers to test changes and help prevent easily avoidable mistakes later on.

New bugfixes or new features should include unit tests. Unit tests are present
with their modules while integration tests are present in
listenbrainz/tests/integration. If you need help with writing a unit test, ask
in IRC or Discourse (links above).

Contributor

jwflory commented Nov 11, 2017

@paramsingh Done! Excerpted from the commit:

Writing unit tests

Unit tests are an important part of ListenBrainz. It helps make it easier for
developers to test changes and help prevent easily avoidable mistakes later on.

New bugfixes or new features should include unit tests. Unit tests are present
with their modules while integration tests are present in
listenbrainz/tests/integration. If you need help with writing a unit test, ask
in IRC or Discourse (links above).

@mayhem mayhem merged commit 99a4983 into metabrainz:master Nov 15, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@jwflory jwflory deleted the jwflory:add/contributing branch Nov 15, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment