Skip to content

Commit 778c5a0

Browse files
Document the development process
1 parent 66831a8 commit 778c5a0

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Features, Bug Reports, Questions
4+
url: https://github.com/basecamp/kamal-proxy/discussions/new/choose
5+
about: Please use the discussions area to report issues or ask questions!
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Pre-Discussed and Approved Topics
3+
about: |-
4+
For topics already discussed and approved in the GitHub Discussions section.
5+
---
6+
7+
** PLEASE START A DISCUSSION INSTEAD OF OPENING AN ISSUE **
8+
** For more details see CONTRIBUTING.md **

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# How to contribute to Kamal Proxy
2+
3+
Kamal Proxy uses GitHub
4+
[discussions](https://github.com/basecamp/kamal-proxy/discussions) to track
5+
feature requests and questions, rather than [the issue
6+
tracker](https://github.com/basecamp/kamal-proxy/issues). If you're considering
7+
opening an issue or pull request, please first open a discussion instead.
8+
9+
Whenever a discussion leads to an actionable and well-understood task, we'll
10+
move it to the issue tracker where it can be worked on.
11+
12+
This is a little different than how some other projects work, but it makes it
13+
easier for us to triage and prioritise the work. It also means that the open
14+
issues all represent agreed-upon tasks that are either being worked on, or are
15+
ready to be worked on.
16+
17+
This should also make it easier to see what's in progress, and to find
18+
something to work on if you'd like to do so.
19+
20+
## What this means in practice
21+
22+
### If you'd like to contribute to the code...
23+
24+
1. If you're interested in working on one of the open issues, please do! We are
25+
grateful for the help!
26+
2. You'll want to make sure someone else isn't already working on the same
27+
issue. If they are, it will be tagged "in progress" and/or it should be clear
28+
from the comments. When in doubt, you can always comment on the issue to ask.
29+
3. Similarly, if you need any help or guidance on the issue, please comment on
30+
the issue as you go, and we'll do our best to help.
31+
4. When you have something ready for review or collaboration, open a PR.
32+
33+
### If you've found a bug...
34+
35+
1. If you don't have steps to reproduce the problem, or you're not certain it's a
36+
bug, open a discussion.
37+
2. If you have steps to reproduce, open an issue.
38+
39+
### If you have an idea for a feature...
40+
41+
1. Open a discussion.
42+
43+
### If you have a question, or are having trouble with configuration...
44+
45+
1. Open a discussion.
46+
47+
Hopefully this process makes it easier for everyone to be involved. Thanks for
48+
helping! ❤️

0 commit comments

Comments
 (0)