yvesgurcan/web-midi-player

Write CONTRIBUTING.md guidelines

Opened this issue · 7 comments

yvesgurcan commented
Write CONTRIBUTING.md guidelines
monsij commented

@yvesgurcan , can you brief me about the any other extra points to mention about in CONTRIBUTING.md. I am up for this task.

  • ❤️1
yvesgurcan commented

Hi Monsij! Welcome to the project. Thank you for offering your help! 🙂

I feel like it would be important to have something that shows contributors that we are grateful for their help and that it is necessary to be respectful towards others.

The Atom guidelines at https://github.com/atom/atom/blob/master/CONTRIBUTING.md and also the Open Government guidelines at https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md look like great models.

In terms of style, the project uses Prettier for linting. I tend to follow the Airbnb JavaScript style guide when I write code but I haven't added it to the linter yet.

The project already has several issue templates and a pull request template, so we can link to them and explain what each template is for.

Another good starting point would be to think about the questions you might have yourself about contributing to this project and see if it would be useful to have the answer in this document.

Does that answer your question? ✋

  • 👍1
monsij commented

Perfect @yvesgurcan . On it!

yvesgurcan commented

Nice! I'm looking forward to seeing the result 🙂

yvesgurcan commented

By the way, I just added a few issues that are good for first contributions to the project. Feel free to dive in!

  • 👍1
yvesgurcan commented

Hi @monsij, any progress on this issue, by any chance?