Skip to content

Commit aa53022

Browse files
authored
Update CONTRIBUTING.md
1 parent 52c80f7 commit aa53022

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

CONTRIBUTING.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Contributing to the PerfView repository
22

3-
First and foremost, we want to thank you for your willingness the help make PerfView better.
3+
First and foremost, we want to thank you for your willingness to help make PerfView better.
44
Here we describe a bunch of rules / advice associated with doing so. You may end up
5-
getting frustrated with the process. This guide is our attempt to keep that frustration
5+
getting frustrated with the process. This guide is our attempt to keep that frustration
66
as low as possible.
77

88
The simple truth is that not all change is good (big surprise), and because of this, we reserve
99
the right to reject any pull request to this repo. We won’t do this without rationale, and
1010
our rationale is simple at its heart.
1111

12-
1. Complexity is bad. Changes that add complexity need more careful deliberation
12+
1. Complexity is bad. Changes that add complexity need more careful deliberation
1313
to weigh the bad against the good that comes along with it.
1414

15-
2. Consistency is good. Bugs are basically a kind of inconsistency (the program does
15+
2. Consistency is good. Bugs are basically a kind of inconsistency (the program does
1616
not work as a simple understanding would assume). There are, of course, feature additions
1717
that make consistency better, but it is all too easy for new features to NOT be consistent
1818
with existing features.
@@ -32,35 +32,35 @@ have the responsibility to weigh these other factors, and we may decide that the
3232
the good.
3333

3434
A rejected pull request is a failure for the repo as a whole because it means that multiple people
35-
spent time on things that ultimately did not benefit the repo. We want to avoid that. There
35+
spent time on things that ultimately did not benefit the repo. We want to avoid that. There
3636
is a simple heuristic that helps:
3737

3838
* **The bigger the change, the more 'pre-vetting' you need**
3939

4040
Thus what we DON'T what you to do is over the course of time build up a rather massive change
41-
and then as some point decide to submit it as a pull request. The likelihood of this landing
41+
and then as some point decide to submit it as a pull request. The likelihood of this landing
4242
in a good place is next to nil.
4343

4444
Small bug fixes / features that do not add interesting complexity are easy, just do them and
45-
submit the pull request. Bigger bug fixes should be vetted by asking first. Code
45+
submit the pull request. Bigger bug fixes should be vetted by asking first. Code
4646
reorganization is particularly tricky. By (1) and (2) we like this assuming it lowers overall
4747
complexity and improves consistency, but it is very disruptive and ideally is done in a series
48-
of small steps. Thus planning is needed, and you should talk with us by posting the issue.
48+
of small steps. Thus planning is needed, and you should talk with us by posting the issue.
4949

5050
In general all features need pre-vetting. The rule here is simple. Don't do any work unless
51-
you
51+
you:
5252

5353
1. Are willing to throw it away (e.g. it was more effort to get it vetted) OR
5454
2. You have vetted it with us by creating an issue, and got positive confirmation from the
55-
discussion that you are on the right track. If it is a big change, you should ongoing
55+
discussion that you are on the right track. If it is a big change, you should stay updated with ongoing
5656
discussion on the issue to insure that you stay on track.
5757

5858
Performance improvements are often a point of contention. Improvements that make the code
59-
smaller / simpler are great, but often this is not the case. If you are adding complexity as
59+
smaller / simpler are great, but often this is not the case. If you are adding complexity as
6060
part of your improvement (e.g. adding a cache), again, you have to follow the rule above
6161
and get it pre-vetted, or be willing to abandon the change. For performance changes in
6262
general we will probably ask you to take measurements to quantify exactly how much improvement
63-
there was. There is more work than just modifying the code.
63+
there was. There is more work than just modifying the code.
6464

6565
## Coding Standards
6666

0 commit comments

Comments
 (0)