Skip to content

Commit

Permalink
📝 Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Add CONTRIBUTING.md and update related files.
  • Loading branch information
LuqueDaniel committed Jan 19, 2019
1 parent 7a17d8c commit a78cfcc
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@
- [ ] My code follows the code style of this project (PEP-8).
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have readed CONTRIBUTING.md.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
__pycache__

# ignore test file
.pytest_cache
pro.py
test.json

Expand Down
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing to Pybooru
:sparkles: Welcome, and thank you for your interest in contributing! :sparkles:

## Resources
* :books: [**Project Documentation**](https://pybooru.readthedocs.io/en/stable/?badge=stable)
* :package: [Pybooru on Pypi](https://pypi.org/project/Pybooru/): Pybooru packages ready to install.
* :woman_student: :man_student: [Code Examples](https://github.com/LuqueDaniel/pybooru/tree/master/examples): examples of how to use Pybooru.
* :construction_worker: [Travis CI](https://travis-ci.org/LuqueDaniel/pybooru): continuous integration for Linux & Mac.
* :construction_worker: [AppVeyor](https://ci.appveyor.com/project/LuqueDaniel/pybooru): continuous integration for Windows.

## Code of Conduct
**Respect each other and be happy! :heart:**

## How Can I Contribute?
### Reporting Bugs
Before reporting a bug, :mag: **[check](https://github.com/LuqueDaniel/pybooru/issues)** if it has already been reported. Bugs are tracked as **[GitHub issues](https://github.com/LuqueDaniel/pybooru/issues)**, so create an issue using **Bug report** template.

* Use a descriptive title
* What behavior was expected?
* What is the current behavior?
* Steps to Reproduce (including code)
* Environment details

### Feature Request
Before request a new feature, :mag: **[check](https://github.com/LuqueDaniel/pybooru/issues)** if it has already been requested. To request a new feature create a **[GitHub issue](https://github.com/LuqueDaniel/pybooru/issues)** using **Feature request** template.

* Write a descriptive title
* Detailed Description of the feature
* Why is this change important to you? How would you use it? How can it benefit other users?

### Pull Requests
Steps to make a pull request:

1. Complete the pull [request template](https://github.com/LuqueDaniel/pybooru/blob/master/.github/pull_request_template.md).
2. Follow [Styleguide](#styleguide).

## Styleguide
We follow **[PEP-8](https://www.python.org/dev/peps/pep-0008/)** (not in a strict way) and **[Google Python Docstrings](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#382-modules)**. Use `Pylint`.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,8 @@ You can consult the documentation on **[Read the Docs](https://pybooru.readthedo
| [Linux & OSX (Travis CI)](https://travis-ci.org/LuqueDaniel/pybooru) | [![Travis CI](https://travis-ci.org/LuqueDaniel/pybooru.svg?branch=master)](https://travis-ci.org/LuqueDaniel/pybooru) | [![Travis CI](https://travis-ci.org/LuqueDaniel/pybooru.svg?branch=develop)](https://travis-ci.org/LuqueDaniel/pybooru) |
| [Windows (AppVeyor)](https://ci.appveyor.com/project/LuqueDaniel/pybooru) | [![AppVeyor](https://img.shields.io/appveyor/ci/luquedaniel/pybooru.svg)](https://ci.appveyor.com/project/LuqueDaniel/pybooru) | [![AppVeyor](https://img.shields.io/appveyor/ci/luquedaniel/pybooru/develop.svg)](https://ci.appveyor.com/project/LuqueDaniel/pybooru) |

## Contributing
Feel free to contribute, take a look at **[CONTRIBUTING](https://github.com/LuqueDaniel/pybooru/blob/master/CONTRIBUTING.md)**.

## License
- **[See MIT License](https://github.com/LuqueDaniel/pybooru/blob/master/LICENSE)**

0 comments on commit a78cfcc

Please sign in to comment.