Skip to content

Commit 139ada9

Browse files
authored
docs: update contributing.md (#1470)
1 parent 56fbbec commit 139ada9

4 files changed

Lines changed: 8 additions & 4 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,16 @@ Make sure you have the following dependencies installed before setting up your d
2929

3030
## How to contribute
3131

32-
- **Fork and Clone:** [Fork the qui repository](https://github.com/autobrr/qui/fork) and clone it to start working on your changes.
32+
- **Pull request access:** This repo restricts pull request creation to **collaborators only**.
33+
- If you are **not** a collaborator: start with an issue/discussion (or Discord) and include a patch (`git diff`) or link to your fork/branch so a maintainer can apply it.
34+
- **Clone:** Clone the repository to start working on your changes. If you are not a collaborator, you can still work from a [fork](https://github.com/autobrr/qui/fork) and share a patch/link (see above).
3335
- **Branching:** Create a new branch for your changes. Use a descriptive name for easy understanding.
3436
- Checkout a new branch for your fix or feature `git checkout -b fix/torrent-actions-issue`
3537
- **Coding:** Ensure your code is well-commented for clarity. With go use `go fmt`
3638
- **Commit Guidelines:** We appreciate the use of [Conventional Commit Guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) when writing your commits.
3739
- Examples: `fix(qbittorrent): improve connection pooling`, `feat(torrent): add bulk actions`
3840
- There is no need for force pushing or rebasing. We squash commits on merge to keep the history clean and manageable.
39-
- **Pull Requests:** Submit a pull request from your Fork with a clear description of your changes. Reference any related issues.
41+
- **Pull Requests:** Open a pull request with a clear description of your changes. Reference any related issues.
4042
- Mark it as Draft if it's still in progress.
4143
- **Code Review:** Be open to feedback during the code review process.
4244

.github/DISCUSSION_TEMPLATE/issue-triage.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ body:
55
value: |
66
> [!IMPORTANT]
77
> Before opening a discussion, please check the [documentation](https://qui.autobrr.com) and search existing [Discussions](https://github.com/autobrr/qui/discussions) and [Issues](https://github.com/autobrr/qui/issues).
8+
>
9+
> Code contributions: PR creation is restricted to collaborators only, so start here (or open an Issue) to coordinate changes.
810
911
- type: textarea
1012
attributes:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Features, Bug Reports, Questions
44
url: https://github.com/autobrr/qui/discussions/new/choose
5-
about: Our preferred starting point if you have any questions or suggestions about issues, features or behavior.
5+
about: Our preferred starting point for questions/suggestions (and contributions; PR creation is collaborators-only).

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Thank you for your support ❤️
104104

105105
## Contributing
106106

107-
Contributions are welcome! Please feel free to submit a Pull Request.
107+
Contributions are welcome. Note: this repo restricts pull request creation to **collaborators only**. Please start with a Discussion/Issue (or Discord) so we can coordinate changes.
108108

109109
## License
110110

0 commit comments

Comments
 (0)