-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CONTRIBUTING.md and update related files.
- Loading branch information
1 parent
7a17d8c
commit a78cfcc
Showing
4 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ | |
__pycache__ | ||
|
||
# ignore test file | ||
.pytest_cache | ||
pro.py | ||
test.json | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters