.gitignore

@@ -1,13 +1,19 @@
-# Logs
-logs
-*.log
-npm-debug.log*
+# dependencies
+/node_modules
 
-# Dependency directories
-node_modules
+# testing
+/coverage
 
-# Editor settings
-.vscode
+# production
+/build
 
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
 
-vendor
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing Guidelines
+
+Welcome to the FreeCodeCamp Python Curriculum contributing guidelines. Here you will find information on:
+
+1. Reporting bugs
+2. Suggesting a new feature
+3. Suggesting a new challenge
+4. Fixing/Updating an existing challenge
+
+## Set Up Local Development Environment
+
+1. Fork this repo
+2. Clone to your machine
+3. `cd` into repository directory
+4. run `npm install`
+5. ren `npm run start` to start application
+6. Code!
+
+## Reporting bugs
+
+Have you discovered a bug within the application?
+- Open a new issue titled: '[Bug] Title/Description of bug'
+- Include which machine, browser & version bug was discovered on
+- Include steps to reproduce the bug
+
+## Suggesting a new feature
+
+Have an idea for a feature to make the app better?
+- Open a new issue titled: '[New Feature] Feature title'
+- Include a brief description what it is and how it will benefit application
+- Propose some sort of pseudocode for how to potentially implement this feature
+
+## Suggesting a new challenge
+
+Want to add to the curriculum?
+- Open a new issue titled: '[New Challenge] Challenge title'
+- Include why this would benefit the curriculum
+- Include resources needed to write the challenge
+
+## Fixing/Updating an existing challenge
+
+Find a mistake in an existing challenge?
+- Open a new issue titled: '[Fix Challenge] Challenge title'
+- Indicate whats wrong with the challenge
+- Propose what needs to be done to fix it if applicable
+
+# Thank you for contributing!
+We couldn't do this without you :heart:

README.md

@@ -1,8 +1,35 @@
 FreeCodeCamp Python Curriculum
 =============
 
+View live: https://freecodecamp.github.io/python-coding-challenges
+
 To run locally:
 1. Fork this repo
 2. Run `git clone [your-fork-url]`
 3. Run `npm install`
-4. Run `npm start`
+4. Run `npm run start`
+
+Adding a new challenge or fixing an existing one?
+
+- Generating challenge ID:
+  1. Open your terminal
+  2. run `mongo`
+  3. run `ObjectId()`
+  4. copy string and paste into lesson_settings.json
+
+- Building challenges.json file:
+  1. Open your terminal
+  2. Navigate to project directory
+  3. run `node generate-challenge-json.js`
+  4. if no errors are thrown you're good to commit and open a pr
+
+- Opening a PR
+  1. Include a reference to the issue
+  2. If its a new challenge, mention the chapter its being added to
+  3. continue being awesome and helping us create this curriculum!
+
+
+Maintaining your Fork:
+  1. `git remote add upstream https://github.com/freeCodeCamp/python-coding-challenges.git`
+  2. `git checkout master`
+  3. `git pull upstream`