-
-
Notifications
You must be signed in to change notification settings - Fork 142
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
Change: improve CONTRIBUTE.md #61
Change: improve CONTRIBUTE.md #61
Conversation
Markdown files can have anchor links, so I thought I'd update the "getting started" to point to what it was referencing. Grammar improvements: title capitalization and it's vs its. "All PRs:" was asking to become a header with the colon and followed list.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. This looks good.
Do you modifying the development section to include this:
Getting started:
npm i
This will link together all the packages.
npm run link
Watch the packages for changes and recompile
npm start
CONTRIBUTING.md
Outdated
@@ -4,7 +4,7 @@ | |||
|
|||
The GraphQL Accounts project was intended - since it's inception - to be a community maintained project. We'd love to see you get involved (especially long time contributors from the Meteor community who we've worked with before). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mind rephrasing this so it doesn't include "GraphQL" since we're transport agnostic.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd be happy to. I was in the process of adding getting started stuff here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, the devel
branch isn't being used to keep the latest development code so references to that should be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should it reference master? Or what are you thinking?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah it's implied. Line 11 has you explicitly checkout devel
We haven't been updating the changelog. If we're gonna keep that in the guidelines then moving forward let's make an effort to do it. |
The rest of the repos under |
This project needs a CHANGELOG.md then? and probably others? |
devel doesn't always have the most pertinent development code. Replaced with general references so that the contributor can decide which branch they are interested in. Didn't feel clean to invade the getting started list. It was just so tidy. There is now a development header that lists useful information for starting project development. This may or may not be what we want.
This looks good. Ready to merge? |
Yessir |
Thank you! |
Glad I could help. Thanks for the learning opportunity! I was originally going to see about increasing code coverage, but got caught up along the way, ha. |
Noticed a few things that might spice up the contribute doc.
Is the section about the changelog still pertinent?