Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (30 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

54 lines (30 loc) · 2.06 KB

How to Contribute to D4D Tutorials

We're very happy you want to contribute! This repository is a community effort, and your help is essential to keeping it relevant and useful.

There are two main ways to contribute:

  1. Request a Tutorial
  2. Add a Tutorial

💡 1. Request a Tutorial

If you want to learn something that isn't covered here, or have a great idea for a tutorial, the best way to suggest it is:

  1. Go to the Issues tab of our repository.

  2. Check if someone hasn't already made the same suggestion.

  3. Click on "New Issue".

  4. Give it a clear title (e.g., [REQUEST] Web Scraping Tutorial with Scrapy).

  5. Describe what you would like to see in the tutorial.

  6. Add the tutorial-request label, if possible.

✍️ 2. Adding a Tutorial

If you have written a tutorial or found an excellent external resource that fits here, the process for adding it is through a Pull Request.

The GitHub Workflow

We use the standard "Fork & Pull" workflow:

  1. Fork: Create a "fork" (copy) of this repository in your own GitHub account.

  2. Clone: Clone your fork to your local machine (git clone ...).

  3. Branch: Create a new "branch" for your changes (git checkout -b my-new-tutorial).

  4. Add Your Tutorial:

  • Create a new folder with a descriptive name (e.g., Web_Scraping/).
  • Add your files (preferably .ipynb or .md).
  • Important: Go back to the main README.md and add a link to your new tutorial in the appropriate section.

  1. Commit: Commit your changes (git commit -m "Add Scrapy tutorial").

  2. Push: Send your changes to your fork (git push origin my-new-tutorial).

  3. Pull Request: Go back to the original Data4Democracy/tutorials repository on GitHub. You will see a button for "Compare & Pull Request". Click it, give it a title and a clear description of what you did, and submit.

One of the project maintainers will review your contribution and, if everything is correct, will merge it.

Thank you for helping build Data for Democracy!