Skip to content

Commit

Permalink
Adding "How To Contribute" to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
yamtimor committed Jul 19, 2023
1 parent e71fe7f commit c96aa69
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
# Open Data Cities Analysis
This repository provides an interactive and welcoming environment for data enthusiasts to learn and gain valuable experience through working with real-world open data from cities around the world. Each city will have a dedicated folder containing all analyses created for that city's data, providing an interactive and highly informative environment.
This repository provides an interactive and welcoming environment for data enthusiasts to learn and gain valuable experience through working with real-world open data from cities around the world.

We encourage users to explore and analyze open-data from cities around the world, and submit meaningful Pull Requests to share their results. Through this repository, we hope to enable users to gain valuable experience while also encouraging cities to open their data to the public.
We warmly welcome users to explore and analyze open data from cities worldwide, and share their insightful findings with the community by contributing their analyses. Moreover, we strongly support data transparency in cities, encouraging them to make their data available to the public. Our shared goal is to build a thriving community that embraces open data initiatives and collaborative learning.

## Projects
| No | City | Project | Description | Author |
| --- | ---------- | ----------------------- | ---------------------------------------------------------------------------- | ---------- |
| 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) |
| 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:


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:
`git checkout -b new-branch-name`
4. **Make Your Changes:** #change this part
5. **Commit Your Changes:**
`git commit -m "Your commit message"`
6. **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 have made a PR to the Open-Data-Cities-Analysis Project! 🚀**

0 comments on commit c96aa69

Please sign in to comment.