Mirrors/kleinanzeigen-bot
1
0
Fork 0
mirror of https://github.com/Second-Hand-Friends/kleinanzeigen-bot.git synced 2026-03-12 02:31:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

update contributing instructions

Browse Source
This commit is contained in:
sebthom
2022-01-19 18:30:32 +01:00
parent a3132e4399
commit 879b9fd088
2 changed files with 27 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@@ -1,15 +1,36 @@
# Contributing # Contributing
Thanks for your interest in contributing to this project! Thanks for your interest in contributing to this project! Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
We want to make contributing as easy and transparent as possible. We want to make contributing as easy and transparent as possible.
Please read through this document before submitting any contributions to ensure your contribution goes to the correct code repository and we have all the necessary information to effectively respond to your request.
## Issues
## Reporting Bugs/Feature Requests
We use GitHub issues to track bugs and feature requests. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. We use GitHub issues to track bugs and feature requests. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
## License ## Contributing via Pull Requests
By contributing your code, you agree to license your contribution under the [GNU Affero General Public License v3.0 or later](LICENSE.txt). Contributions via pull requests are much appreciated.
Before sending us a pull request, please ensure that:
1. You are working against the latest source on the **main** branch.
1. You check existing open and recently merged pull requests to make sure someone else hasn't already addressed the issue.
To send us a pull request, please:
1. Fork our repository.
1. Modify the source while focusing on the specific change you are contributing.
1. Commit to your fork using clear, descriptive commit messages.
1. Send us a pull request, answering any default questions in the pull request interface.
GitHub provides additional documentation on [forking a repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull request](https://help.github.com/articles/creating-a-pull-request/)
## Licensing
See the [LICENSE.txt](LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

2
README.md
View File

@@ -196,6 +196,8 @@ updated_on: # set automatically
## <a name="development"></a> Development Notes ## <a name="development"></a> Development Notes
> Please read [CONTRIBUTING.md](CONTRIBUTING.md) before contributing code. Thank you!
- Installing dev dependencies: `pip install .[dev]` - Installing dev dependencies: `pip install .[dev]`
- Running unit tests: `python -m pytest` or `pytest` - Running unit tests: `python -m pytest` or `pytest`
- Running linter: `python -m pylint kleinanzeigen_bot` or `pylint kleinanzeigen_bot` - Running linter: `python -m pylint kleinanzeigen_bot` or `pylint kleinanzeigen_bot`