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
Update Pinax Quick Start and pinax/pinax README with new pinax-cli way of starting projects #102
Right now the Quick Start in the Pinax documentation and the README of this repository still show the "manual" way of starting Pinax starter projects. Since there's now an easier way to do that with the Pinax Command Line (pinax-cli) both of these documents need to be updated. We'd like to give someone who has never contributed to open source before a chance to tackle this task in order to make their first OSS contribution. If you have contributed to open source before, please let someone else take this one. Below you can find some guidelines and instructions on what you need to do:
One of us will then review your pull request and if everything looks great we will merge it (you will receive an email notification from GitHub). If you need to make additional changes, we will comment on your pull request and help you figure out the next steps. Don't worry, this is totally normal and doesn't mean that your pull request isn't awesome. Sometimes it just happens that a few things need to be tweaked.
If you have any questions or need help, comment on this issue and mention me @ossanna16 (I will receive a notification this way). One of us will then reply and help you. It's even better if you would join our Pinax Slack channel (it's free). Someone is always there to help and answer any questions. If you'd like to reach me personally mention me @anna in our Pinax project Slack channel. Please remember that there are no stupid questions. We want to help you succeed and want to help you make your first open source contribution.
Hi! I'm the creator of twitter.com/yourfirstpr, a project that shares great starter issues with beginners to programming and open source. I just wanted to take the time to say wow, what an amazing and comprehensive issue! I think it the best I have seen so far and it makes me so happy.
I'll be tweeting this Friday afternoon (1PM GMT!).
Thank you again
@Charlotteis Thank you for your kind words, Charlotte
referenced this issue
Jan 24, 2016
I'm brand new when it comes to making OSS contributions. This looks like a great way to get started. Thanks for posting it. I'm in the process of trying it out.
Looks like the part of the issue dealing with README.md has already been addressed in a previous commit (364f8b0) I'm assuming it's ok to continue on with the other portions of the issue though.
Also, I noticed that in docs/quick_start.md the startproject command uses an argument "-n webpack.config.js" whereas the corresponding line in README.md did not. I'm assuming this not an issue and the argument can simply be left off in the cli version of the command.
Thanks again for posting this. I'm looking forward to sending a pull request!