From 4b62ccfa49a2464794afac423cab8fb600194997 Mon Sep 17 00:00:00 2001 From: Lyx Date: Tue, 18 Mar 2025 18:55:32 +0100 Subject: [PATCH] Added how to contribute section to readme --- readme.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/readme.md b/readme.md index 3b7ef86..52fb1ef 100644 --- a/readme.md +++ b/readme.md @@ -3,3 +3,15 @@ WeaterCLI is a simple weather application that uses the [NowCast from met.no](ht To use this you need to modify [.env.example](https://github.com/Lyxminxx/weatherCLI/blob/master/.env.example) and change the spot that says youremail to be your email. Then rename the file to .env\ At this point just run ```pip install -r requirements.txt``` to install the dependencies. Then run [main.py](https://github.com/Lyxminxx/weatherCLI/blob/master/main.py).\ Feel free to add your own cities in Norway, Sweden, Denmark or Finland by adding it to [possistions.py](https://github.com/Lyxminxx/weatherCLI/blob/master/possistions.py) + +## Want to contribute? +Contributions are welcome! Whether it's adding new cities, improving the code, or suggesting features, your help makes **weatherCLI** better. Here's how you can contribute: + +1. **Check the Issues Tab** – Look for open issues labeled `good first issue` or `help wanted`. +2. **Add More Cities** – Follow the guide above to add cities and submit a pull request. +3. **Suggest Features** – Open a discussion or issue if you have ideas to improve the project. +4. **Fix Bugs & Improve Code** – Found a bug? Want to optimize something? Submit a PR. +5. **Spread the Word** – If you like this project, give it a ⭐ and share it. + +**License:** This project is GPL 3.0 licensed, meaning your contributions must also be open-source. +