Skip to content

Commit

Permalink
add two new steps to "How to contribute"
Browse files Browse the repository at this point in the history
  • Loading branch information
yamtimor committed Jul 20, 2023
1 parent fea2ae6 commit 5c2d268
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,34 @@ We warmly welcome users to explore and analyze open data from cities worldwide,
| --- | ---------- | ----------------------- | ---------------------------------------------------------------------------- | ---------- |
| 1 | BeerSheba | [Beersheba-Trees-Heatmap](https://github.com/yamtimor/Open-Data-Cities-Analysis/tree/main/BeerSheba/Beersheba-Trees-Heatmap) | The project aims to generate a heatmap using Beersheba municipality's API to visualize the distribution of trees in the city. | [Yam Timor](https://github.com/yamtimor) |

## How To Contribute:


## How to contribute:
1. **Explore the Project:** Familiarize yourself with the project's goals and guidelines.
2. **Fork the Repository:** Click the `Fork` button on the top right of the repository page.
3. **Create a New Branch:** On your forked repository, create a new branch using:
2. **select a city that has an open data portal:** For instance, I've chosen BeerSheba, Israel. If your city (or another city that interests you) has a public data portal, great! Otherwise, if you're looking for a good starting point, New York City has an excellent Open Data Portal, which you can find [here]( https://opendata.cityofnewyork.us/).
3. **Find a dataset that catches your interest:** It's even cooler if there's a public API access instead of dealing with files.
4. **Fork the Repository:** Click the `Fork` button on the top right of the repository page.
5. **Create a New Branch:** On your forked repository, create a new branch using:
```
git checkout -b new-branch-name
```

4. **Make Your Changes:** Edit/add files and make your desired contributions.
6. **Make Your Changes:** Edit/add files and make your desired contributions.

- Each city should have its own folder: Create a new folder with the city's name if it doesn't exist, and avoid duplicating it if it already does.

- Each project should have its own folder inside the city folder: For existing city projects, place your files in the appropriate folder. For new projects in the city, create a new folder with a descriptive title for your project.

5. **Commit Your Changes:**
7. **Commit Your Changes:**
```
git commit -m "Your commit message"
```
6. **Push to Your Fork:**
8. **Push to Your Fork:**
```
git push origin new-branch-name
```
7. **Submit a Pull Request:** To create a pull request, click on `compare and pull requests`
8. **Add appropriate title and description:** Ensure your PR title and description include the name of the project and the related city.
9. **Click on `Create Pull Request`**
10. **Awsome! You've made a PR to the Open-Data-Cities-Analysis Project! 🚀**
9. **Submit a Pull Request:** To create a pull request, click on `compare and pull requests`
10. **Add appropriate title and description:** Ensure your PR title and description include the name of the project and the related city.
11. **Click on `Create Pull Request`**
12. **Awsome! You've made a PR to the Open-Data-Cities-Analysis Project! 🚀**

## Contributors
<a href="https://github.com/yamtimor/Open-Data-Cities-Analysis/graphs/contributors">
Expand Down

0 comments on commit 5c2d268

Please sign in to comment.