diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..02471aaaa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: true +contact_links: + - name: Just ask the community a question + url: https://discord.gg/52mZGC3JXJ + about: Community help about pymobiledevice3. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 89804918f..cab3fc076 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -20,4 +20,5 @@ A clear and concise description of any alternative solutions or features you've Add any other context or screenshots about the feature request here. ## For community -⬇️ **Please click the 👍 reaction instead of leaving a `+1` or 👍 comment** \ No newline at end of file + +⬇️ **Please click the 👍 reaction instead of leaving a `+1` or 👍 comment** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..646414827 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,13 @@ + + +## For community + +⬇️ **Please click the 👍 reaction instead of leaving a `+1` or 👍 comment** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58c4c98dd..39a107b69 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,17 @@ # Contibuting -If you would like to contribute, feel free to report issues, start new discussions, or create pull requests. You can -also contact us on Discord: +If you would like to contribute, feel free to report issues, start new discussions, or create pull requests. + +In general we recommend using our pre-commit hook which enforce the linter rules we use: + +```shell +python3 -m pip install -U pre-commit +pre-commit install +``` + +In addition, please note we prefer using `'` for strings instead of `"`. + +If you're having any troubles, You can also contact us on Discord: