Contributing

Contributing to the Propeller Repository

Want to contribute to the Propeller repository? Please do! We welcome helpful resources like objects, and links to projects, articles, and discussions.

Contribution Video

Here's an explanatory video about submitting Propeller Objects:

Three Ways to Contribute

Whether you want to submit a Propeller object, links to resources, or suggestions, the process is similar and there are are three ways you can participate; choose whichever you like.

Method 1 (recommended) - Git + GitHub User

1. Go to the repository page and fork the repository to your own GitHub account.

2. Clone your fork to your local system.

3. Add Parallax Propeller repo to your local repo's remote list as upstream

   $ git remote add upstream https://github.com/parallaxinc/propeller
   

4. Make your enhancements, view/verify locally, then use Git to commit and push them back to your fork.

   <make changes and verify, then...>
   $ git add --all
   $ git commit -m "helpful comments"
   $ git push origin master
   

5. Submit a PR of your changes for Parallax to review and merge.

TIP:

Make sure you resync your fork to the upstream to stay up-to-date:

Assuming your local repo uses the nicknames origin (for your fork [the default]) and upstream (for the Parallax Propeller repo)

$ git pull upstream master
$ git push origin master

Method 2 - Non-Git User

1. Type your suggestions, or archive (zip up) your contribution (if necessary), and submit it as a new issue with a clear explanation of what is included.

Method 3 - Non-Git User

1. Email your suggestions or contributions (archived/zipped up if necessary) to Parallax Developer with a clear explanation of what is included.