Contributing Guide for 1.0 #727
Conversation
|
Deploy preview ready! Built with commit 88cf034 |
|
Deploy preview ready! Built with commit 88cf034 |
|
Hey! This looks great and very needed. Could you also symlink the file to /docs/docs/how-to-contribute.md so it shows up at https://www.gatsbyjs.org/docs/how-to-contribute/ ? |
|
@KyleAMathews, sure can, how does that look? |
|
Oh cool that worked! I wasn't entirely sure if it would or not :-) https://deploy-preview-727--gatsbyjs.netlify.com/docs/how-to-contribute/ Could you also add a: # How to contributeAt the top? |
|
Yup, sure can. |
CONTRIBUTING.md
Outdated
| * Install dependencies: `yarn && lerna bootstrap` | ||
| * Make sure tests are passing for you: `lerna run test` | ||
| * Create a topic branch: `git checkout -b topics/new-feature-name` | ||
| * Run `yarn build && yarn watch` to watch code and compile your changes. |
There was a problem hiding this comment.
watching also builds all the files when it starts up the watcher.
Also it's yarn run watch not yarn watch.
There was a problem hiding this comment.
What I was seeing was if there were build errors, watch was completely silent, while build would actually build and show the errors. So it looked on my machine that watch didn't actually build if there were errors, and you couldn't see these errors, so I more wanted those to be front and centre for people if they're just getting started.
Also, yarn watch is actually equivalent (today at least) to yarn run watch, but I'm happy to change that over. It's true that if they do ever create a true yarn watch proper then this would suddenly stop working, while yarn run watch would continue to work.
There was a problem hiding this comment.
@KyleAMathews I think in my latest changes I've actioned this feedback. If not please let me know!
|
This is great. I would suggest also to add a section on how to "link" the development repo to a test repository. I shared my experience trying to do it in #731, despite I didn't succeed yet. |
…ommand more apparent.
|
Thanks for the improvements here! Merging and let's all keep making improvements here to help people new to Gatsby dev. |
|
Hiya @blargity! 👋 This is definitely late, but on behalf of the entire Gatsby community, I wanted to say thank you for being here. Gatsby is built by awesome people like you. Let us say “thanks” in two ways:
If you have questions, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’. Thanks again! 💪💜 |
It looks like the contributing.md file for 1.0 isn't up to date. I still can't get it to work, but this is closer. I've never built a global cli tool with node before that needed to be linked, so when you throw lerna in on top of that I'm not sure how to get started.