diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b30aa2b..aac08cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,60 +4,84 @@ The code is quite modular and here is a brief overview how it works. -There is a global variable `SHOW_DEBUG` which is taken as a parameter by almost all functions. If this is set to true it shows useful debugging info and a nice progress bar. +There is a global variable `SHOW_DEBUG` which is taken as a parameter by almost +all functions. If this is set to true it shows useful debugging info and a nice +progress bar. -Inside the `lib` folder the python codes reside. +Inside the `dwc` folder the python codes reside. -* `ballontip.py` sends a notification to the notification panel. +* `ballontip.py` sends a notification to the notification panel. (for Windows OS +only) * `debug.py` prints download status bar on the terminal. * `utils.py` does the following - - 1. `save_image`: This takes url of image, path where the image will be saved locally and SHOW_DEBUG as parameters. It returns the path where the image is saved. + 1. `save_image`: This takes url of image, path where the image will be saved + locally and SHOW_DEBUG as parameters. It returns the path where the image is + saved. - 2. `set_wallpaper_permanent`: This takes the path of the image where it is saved locally and SHOW_DEBUG as parameters. It changes the wallpaper to the specifies image and also sends a notification. + 2. `set_wallpaper_permanent`: This takes the path of the image where it is + saved locally and `SHOW_DEBUG` as parameters. It changes the wallpaper to + the specifies image and also sends a notification. -* If you want to add another source simply create a file in the `lib` folder and use the above functionalities. +* If you want to add another source simply create a file in the `dwc/sources` +folder and use the above functionalities. ## Getting Involved -This project is in its early stage of development and we need your help. Please open an issue if you have spotted a bug or create a pull request if you have added a cool feature! +This project is in its early stage of development and we need your help. Please +open an issue if you have spotted a bug or create a pull request if you have +added a cool feature! ### Making a pull request -Please open a **new issue** before making any pull request. **Every pull request should have a reference to an issue**. +Please open a **new issue** before making any pull request if it doesn't exist. +**Every pull request should have a reference to an issue**. Also please make +sure there is no open pull request for the same issue. * First, fork this repository. * Clone it using `git clone https://github.com/[username]/Desktop-Wallpaper-Changer.git` -* It is always recommended to make your changes in a new branch rather than master. So create a new branch using `git branch mybug`. +* It is always recommended to make your changes in a new branch rather than +master. So create a new branch using `git branch my_branch`. -* Checkout into your new branch using `git checkout mybug`. +* Checkout into your new branch using `git checkout my_branch`. -* Hack the code, kill the bug or introduce the new feature you had in mind, do all kinds of awesome stuff. +* Hack the code, kill the bug or introduce the new feature you had in mind, do +all kinds of awesome stuff. * After you are done add your changes using `git add --all` -* Commit your changes using git commit and provide a commit message: `git commit -m "" `. +* Commit your changes using git commit and provide a commit message: +`git commit -m "" `. -* After you have committed your changes push your changes to your forked repository using `git push origin mybug`. +* After you have committed your changes push your changes to your forked +repository using `git push origin my_branch`. * Finally create a pull request from github. -* If everything is alright then soon your changes will get merged or else you will be asked to make changes. +* If everything is alright then soon your changes will get merged or else you +will be asked to make changes. -There should be **only one commit per pull request**. -Please try to make sure that your commit message and body follows the guidelines below. +Please try to make sure that your commit message and body follows the guidelines +below. -* Commit message should be of the form : `fixes issue #[issue_number] - what you solved in one line` +* Commit message should be of the form: + ``` + What you did in one line + Fixes/Closes #issue_no + ``` -* After Commit message there should follow a commit body where you can mention what you did in short or in detail. +* After Commit message there may follow a optional commit body where you can +mention what you did in short or in detail. -* Please make sure that your code follows `PEP8` guidelines. You may read more at [here](https://pep8.org). +* Please make sure that your code follows `PEP8` guidelines. You may read more +at [here](https://pep8.org). * Also keep your master branch always updated. -Please try to follow this format as it will be helpful for maintainers as well as co-developers/contributors to stay aligned. +Please try to follow this format as it will be helpful for maintainers as well +as co-developers/contributors to stay aligned. diff --git a/README.md b/README.md index 8469431..f8c3dfa 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # Desktop Wallpaper Changer -> This python script fetches images from popular sources and set those as your desktop wallpaper. +> This python script fetches images from popular sources and set those as your +desktop wallpaper! [![Codacy Badge](https://api.codacy.com/project/badge/Grade/54b27c2612ee4301924e701d1b081375)](https://app.codacy.com/app/ayan-b/Desktop-Wallpaper-Changer) [![Build Status](https://travis-ci.org/ayan-b/Desktop-Wallpaper-Changer.svg?branch=master)](https://travis-ci.org/ayan-b/Desktop-Wallpaper-Changer) @@ -9,7 +10,8 @@ -Desktop Wallpaper Changer fetches images from popular sources and set those as your desktop wallpaper. Currently supported sources are: +Desktop Wallpaper Changer fetches images from popular sources and set those as +your desktop wallpaper. Currently supported sources are: - NASA Astronomical Picture of the Day - Bing Picture of the Day - Random Pictures from Unsplash.com @@ -39,5 +41,5 @@ Desktop Wallpaper Changer fetches images from popular sources and set those as y ## Contributing Want to contribute? Awesome! :tada: -Please head over to [CONTRIBUTING.md](/CONTRIBUTING.md) to check out how the -code works and some guidelines regarding contributions! +Please head over to [CONTRIBUTING.md](https://github.com/ayan-b/Desktop-Wallpaper-Changer/blob/master/CONTRIBUTING.md) +to check out how the code works and some guidelines regarding contributions!