Skip to content
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

chore: add CONTRIBUTING.md #520

Merged
merged 1 commit into from
Apr 23, 2018
Merged

chore: add CONTRIBUTING.md #520

merged 1 commit into from
Apr 23, 2018

Conversation

tkurki
Copy link
Member

@tkurki tkurki commented Apr 22, 2018

Add instructions relating to PR flow and commit
messages. These have been unformalised so far. It
is a bit nasty to ask for changes in PRs when these
have been nowhere to find. Partially copied from
Angular DEVELOPERS.md.

@tkurki tkurki requested a review from sbender9 April 22, 2018 07:48
@webmasterkai
Copy link
Contributor

This looks good to me. I might suggest we move the file to /docs so that it automatically shows up on issue creation for new users to review. https://help.github.com/articles/setting-guidelines-for-repository-contributors/

I like the Pull Request and Commit messages section https://github.com/SignalK/specification/blob/master/CONTRIBUTING.md and how it lists the enums.

Might also be worth having an example git commit command to go along withe the others you have there.

Add instructions relating to PR flow and commit
messages. These have been unformalised so far. It
is a bit nasty to ask for changes in PRs when these
have been nowhere to find. Partially copied from
Angular DEVELOPERS.md.
@tkurki tkurki force-pushed the add-contributing branch from edba958 to 0ef63dd Compare April 22, 2018 15:58
@tkurki
Copy link
Member Author

tkurki commented Apr 22, 2018

  • moved to docs
  • added inline commit message guidelines in addition to the link

If you can't find your way to git commit then this doc has no hope - I want to include the stuff that even a bit more experienced people have trouble with.

@tkurki tkurki merged commit 12c3cac into master Apr 23, 2018
@tkurki tkurki deleted the add-contributing branch April 23, 2018 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants