Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
`Development.md`: How to Develop Meteor Itself #8267
The current edition of Contributing.md is great in that it's beginning to offer a lot of information on the various ways to contribute to Meteor aside from just code contributions including Issue Triaging, PR help, etc.
It falls a bit short when it comes to actual development though as there is also quite a bit that is undocumented in that aspect. There's a bit of a section on running Meteor tests, but aside from the "Slow start for developers" section of the
The initial straw-man proposal here is:
Contributing.md can then gain some additional information like where to find work:
There are a number of community contributors (myself included) who I think might have some great perspective on this
Then again, if we just want to gather all the suggestions here and I can try to go at it in one caffeine-induced pass.
Thoughts? What are we missing to make it easier to contribute here.
Good idea, this would have helped me a lot in the past.
Although a bit outdated with the move to NPM. As the developer of https://github.com/sebakerckhof/stratosphere (private meteor package server) I could write a secton on how the meteor package system works.
@e50 I think it would be great if someone could pull something like that off at a Meteor Meetup or something (and then get it online), but I'd say it's too much to include in this issue; I think searchable documentation is the first goal. Once this is done, it might encourage something like that to happen and perhaps snowballing contribution effects will ensue.
I've gone ahead and converted this to a PR per the above conversation. PRs against this branch (
changed the title from
Create a `Development.md`
[WIP] Create a `Development.md`
Jan 25, 2017
This all looks great @abernix - I added a few small comments regarding typo's/structuring, but this looks like it's good to go!
The only additional details I can think to add that might be helpful for developers, are a few tips on how to use git effectively when working on the core. Things like how to keep your clone in synch with the meteor repo, how to keep your branch up to date with devel, recommendations on squashing commits (to do or not to do, until a PR is about to be merged for example), etc. That being said, this really is more general git help, so maybe we don't want to go there. Given the number of recent PR's that have been opened by mistake or include commits that don't belong however, maybe it's worth considering.
That's a very reasonable suggestion and it's probably a good idea. There are a lot of great developers who don't (or have never used) Git.
My hunch is that we could find some awesome tutorials that other projects link to. I'm going to vote for getting this done (as is) for now and adding that as soon as someone can work on it. The next phase of this is to find ways to hook developers into it, so we do want to make sure they're ready when they get here!
Mar 9, 2017
A huge "thanks" to everyone who helped review this or made suggestions initially, and since this issue is mostly followed by those who help triage, maintain positive direction in the project or make high-quality contributions regularly, for all of your assistance!
(Also, a proactive "thank you" to anyone who uses these tips to make contributions in the future! Anyone looking for a place to test these instructions, these issues are ready to go
If anything else comes to mind for these either of these docs, feel free to make a pull-request! It's as easy as clicking "Edit" on GitHub.