Login

Enter your GitHub username and email address. If you don't have one yet, go ahead and create an account on the GitHub website.

Clone the Repository

Click on the "Clone a Repository from the internet..." button.

Select the URL tab and enter the website into the text field.

https://github.com/adafruit/Adafruit_CAD_Parts

Under Local Path, click on the Choose button and select a directory for the CAD files to reside in.

Click the Clone button when ready.

Create a Branch

Click on the Current Branch tab and then the New Branch button.

Type in a desired name for your new branch. This can be your username or anything relevant to your project.

In the Switch Banch dialog, select "Bring My Changes to New Branch" and then click the Switch Branch button.

Add Your Files

In your local repository, create a new folder titled with the product ID and the name of the part you'd like to add. Each part should have its own folder.

CAD files should be in the STEP and STL format (F3D file if available). A JPG or GIF image is also recommended.

Enter a summary and description in the changes tab. Click the check boxes for each file to include it in the commit.

If you're using Mac OS, DO NOT include any .DS_Store files.

Click Commit to My Branch when ready.

Fork Branch

Select Fork This Branch when prompted.

Then, select "To contribute to the parent project" in the "How are you planning to use this fork" dialog.

Click Publish when ready.

Compare & pull request

Go to the web browser and load the Adafruit CAD Parts repository on GitHub.

Click on the Compare & pull request button in the top of the part list.

Open a Pull Request

Verify your summary and description are correct. You can also add any additional details if you'd like.

When ready, click on the Create pull request button.

Committed Pull Request

Congratulations on opening your Pull Request!

If everything went well, you should see a green check mark and a message regarding the branch has no conflicts. 

Pull Requests

Your new pull request will appear in the Pull Request tab.

The moderators of the repository will be notified when a new pull request has been submitted.

Please allow the moderators time to review your pull request.

PR successfully merged and closed

You will be notified when your PR has been merged.

Once you're all set, you can safely delete your branch.

Click on the Delete branch button to tidy up your pull request.

Contributed Parts

Your files will be listed in the main repository for everyone to see and have access to download.

Your username will be tied to your files so everyone will know that you added them.

Thank you for contributing to the repository!