@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Update some more "contributing" docs
Summary:
Ref T12922.
- Remove most mentions to "Contributing Feature Requests".
- Raise the barrier to entry on code contributions.
I'm going to tweak "Bug Reports" in a followup to be more similar to "Feature Requests", but that's a slightly more involved change.
Test Plan: Read new docs.
Reviewers: chad
Reviewed By: chad
Maniphest Tasks: T12922
Differential Revision: https://secure.phabricator.com/D18235
+41
-83
-4
src/docs/contributor/bug_reports.diviner
-4
src/docs/contributor/bug_reports.diviner
···
32
32
33
33
The rest of this article walks through these points in detail.
34
34
35
-
If you have a feature request (not a bug report), see
36
-
@{article:Contributing Feature Requests} for a more tailored guide.
37
-
38
35
For general information on contributing to Phabricator, see
39
36
@{article:Contributor Introduction}.
40
37
···
179
176
180
177
Continue by:
181
178
182
-
- learning about @{article: Contributing Feature Requests}; or
183
179
- reading general support information in @{article:Support Resources}; or
184
180
- returning to the @{article:Contributor Introduction}.
+6
-15
src/docs/contributor/contrib_intro.diviner
+6
-15
src/docs/contributor/contrib_intro.diviner
···
21
21
commitment, or having to touch PHP, here are some ways you can materially
22
22
contribute to Phabricator:
23
23
24
-
- Send us an email or drop by IRC just to say "thanks". A big part of the
25
-
reason we build this software is to help people solve problems, and knowing
26
-
that our efforts are appreciated is really rewarding.
24
+
- Drop by the [[ https://phurl.io/u/discourse | community forum ]] just to
25
+
say "thanks". A big part of the reason we build this software is to help
26
+
people solve problems, and knowing that our efforts are appreciated is
27
+
really rewarding.
27
28
- Recommend Phabricator to people who you think might find it useful. Our
28
29
most powerful growth channel is word of mouth, and mentioning or tweeting
29
30
about Phabricator helps the project grow. If writing a tweet sounds like
···
36
37
37
38
> Phabricator is objectively the best thing. Source: I am a certified, internationally recognized expert.
38
39
39
-
- Report bugs and request features. We may not always be able to fix or build
40
-
things right away, but knowing about issues users are encountering or
41
-
features they'd like to see improves our ability to plan and prioritize.
42
-
- For details on reporting bugs, see @{article:Contributing Bug Reports}.
43
-
- For details on requesting features, see @{article:Contributing Feature
44
-
Requests}.
45
-
- Give us feedback on planned features. Most of what we'll build in the next
46
-
6-12 months currently exists on the [[ Roadmap ]] or in Maniphest. Telling
47
-
us about use cases you have can help us build better products when the time
48
-
comes to write the code.
40
+
- Submit high-quality bug reports by carefully following the guide in
41
+
@{article:Contributing Bug Reports}.
49
42
50
43
If all of this sounds nice but you really just want to write some code, be
51
44
aware that this project often presents a high barrier to entry for new
···
58
51
Continue by:
59
52
60
53
- learning about bug reports in @{article:Contributing Bug Reports};
61
-
- learning about feature requests in
62
-
@{article:Contributing Feature Requests}; or
63
54
- learning about code contributions in @{article:Contributing Code}.
+18
-36
src/docs/contributor/contributing_code.diviner
+18
-36
src/docs/contributor/contributing_code.diviner
···
3
3
4
4
Describes how to contribute code to Phabricator.
5
5
6
+
Level Requirements
7
+
==================
8
+
9
+
To contribute to the Phabricator upstream, you must first pass a series of
10
+
ancient trials and be invited to register an account in the ancestral
11
+
homeland of Phabricator, here on `secure.phabricator.com`. The nature and
12
+
location of these trials is a closely guarded secret.
13
+
14
+
If you have passed these trials, this document can guide you through
15
+
contributing code.
16
+
17
+
If you have not yet passed these trials, writing code is normally not the best
18
+
way to contribute to Phabricator. See @{article:Contributor Introduction} for
19
+
more information.
20
+
21
+
6
22
Overview
7
23
========
8
24
···
32
48
Coordinate First
33
49
================
34
50
35
-
Before sending code, you should file a bug report or feature request describing
36
-
what you'd like to write. For details on how to do this, see these articles:
37
-
38
-
- @{article:Contributing Bug Reports}
39
-
- @{article:Contributing Feature Requests}
51
+
Before sending code, you should file a task describing what you'd like to write.
40
52
41
53
When you file a task, mention that you'd like to write the code to fix it. We
42
54
can help contextualize your request or bug and guide you through writing an
···
74
86
you're building it in a way that we're comfortable taking over.
75
87
76
88
**Not a Good Fit**: Many patches aren't good fits for the upstream: they
77
-
implement features we simply don't want. You can find more information in
78
-
@{article:Contributing Feature Requests}. Coordinating with us first helps
89
+
implement features we simply don't want. Coordinating with us first helps
79
90
make sure we're on the same page and interested in a feature.
80
91
81
92
The most common type of patch along these lines is a patch which adds new
···
217
228
In general, if you're coordinating with us first, we can usually provide
218
229
guidance on how to implement things. The other articles in this section also
219
230
provide information on how to work in the Phabricator codebase.
220
-
221
-
Not Sure Where To Get Started?
222
-
==============================
223
-
224
-
If you don't have a specific bug or feature in mind and just want to write
225
-
some code, you can try to find something simple to get started with.
226
-
227
-
Because we're usually quick to fix easy bugs and issues, we often don't have a
228
-
very good backlog of starter tasks.
229
-
230
-
You can try searching in Maniphest for tasks tagged with #easy, which might
231
-
have something, but a lot of time this list is small and the tasks on it aren't
232
-
very fun or interesting even if they aren't technically too difficult.
233
-
234
-
In general, the best way to contribute is to come to us with a problem you
235
-
encountered or something you're interested in building, and then work with us
236
-
to find a solution to it or a plan to build it. We can help turn a hacky patch
237
-
into something that's upstreamable, and you'll get a fix or feature you want.
238
-
239
-
You can also look though the rest of the open tasks for something more
240
-
substantive that you're interested in. This will give you a better chance of
241
-
finding something that's relevant to you, but many tasks are large or blocked
242
-
by other large tasks.
243
-
244
-
If you do find something, feel free to leave a comment like "I'm interested in
245
-
working on this, is this something I could reasonably help with?". We're happy
246
-
to walk through things, break larger tasks down into more detail, provide
247
-
pointers to similar changes and the right places in the codebase to get started,
248
-
and generally figure out how to attack a problem.
249
231
250
232
251
233
Next Steps
+17
-28
src/docs/contributor/feature_requests.diviner
+17
-28
src/docs/contributor/feature_requests.diviner
···
3
3
4
4
Describes how to file an effective Phabricator feature request.
5
5
6
-
Describe Your Problem!
7
-
======================
6
+
7
+
Level Requirements
8
+
==================
9
+
10
+
We accept feature requests through two channels: paid support and community
11
+
support.
12
+
13
+
If you are a paying customer, use the
14
+
[[ https://admin.phacility.com/u/support | Support Channel ]] for your account
15
+
to request features. This document may help you frame your requests in a way
16
+
that lets us address them more quickly, but you do not need to read it or
17
+
follow the guidelines.
18
+
19
+
Other users can file requests on the
20
+
[[ https://phurl.io/u/discourse | community forum ]].
8
21
9
-
IMPORTANT: When filing a feature request, you **MUST** describe the root
10
-
problem you are facing. We will not accept feature requests which do not
11
-
include a problem description. See below for details.
12
22
13
23
Overview
14
24
========
15
25
16
-
Have a feature you'd like to see in Phabricator? This article describes how
17
-
to file an effective feature request.
26
+
This article describes how to file an effective feature request.
18
27
19
28
The most important things to do are:
20
29
21
30
- understand the upstream;
22
31
- make sure your feature makes sense in the project;
23
32
- align your expectations around timelines and priorities;
24
-
- describe your problem, not your solution; and
25
-
- file a task in
26
-
[[ http://secure.phabricator.com/u/newfeature/ | Maniphest ]].
33
+
- describe your problem, not your solution.
27
34
28
35
The rest of this article walks through these points in detail.
29
36
···
139
146
your feature will materialize. That day may be a decade from now. You should
140
147
have realistic expectations about this when filing a feature request.
141
148
142
-
If you want a concrete timeline, you can work with us to pay for some control
143
-
over our roadmap. For details, see
144
-
[[ https://secure.phabricator.com/w/prioritization/ | Prioritization ]].
145
-
146
149
147
150
Describe Problems
148
151
=================
···
217
220
218
221
Generally, you should wait until a problem actually occurs before filing a
219
222
request about it.
220
-
221
-
222
-
Create a Task in Maniphest
223
-
==========================
224
-
225
-
If you think your feature might be a good fit for the upstream, have reasonable
226
-
expectations about it, and have a good description of the problem you're trying
227
-
to solve, you're ready to file a feature request.
228
-
229
-
It is **particularly critical** that you describe the problem you are facing,
230
-
not just the feature you want. We will not accept feature requests which do
231
-
not describe the root problem the feature is intended to resolve.
232
-
233
-
(NOTE) https://secure.phabricator.com/u/newfeature/
234
223
235
224
236
225
Next Steps