search

deejcunningham / skill-score

Deprecated Mycroft skill to report latest MLB scores
MIT License
3 stars 5 forks source link

Add Contributing Section to ReadMe #17

Open ljl7123 opened 6 years ago

ljl7123 commented 6 years ago

I was thinking of adding a contributing section to the README. Could you clarify the following:

  1. are first time contributors welcome?
  2. are there any files with version numbers that need to be incremented?

For the rest of the contributing section, I was thinking of outlining that:

  1. open issues should be looked at or a new issue opened before submitting a PR
  2. for each PR, the README should be updated if needed and version numbers incremented.

Thanks in advance!

deejcunningham commented 6 years ago
  1. Anybody is welcome to contribute!
  2. Version numbering is unnecessary and not used here.
  3. I agree that issues should be opened before submitting PRs and the README should be updated if the PR changes something significant. Users will likely not interact with the README but will instead (probably mostly) install the skill using voice via Mycroft or via msm.

So with that in mind, the README serves two purposes: first - it must fit a specific format when submitting the skill to Mycroft and second - it would help a contributor get their bearings in order to contribute.