Skip to content

Commit 06cc47c

Browse files
committed
[meta] CONTRIBUTING.md: link to CoC; soft wrap instead of hard wrap
1 parent 5cf5038 commit 06cc47c

File tree

1 file changed

+16
-61
lines changed

1 file changed

+16
-61
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Contributing
22

3-
Thanks for your interest in helping out! Here are a **few** _weird_ tricks to
4-
~~cut your mortgage in half~~ maximize the global net efficiency of your efforts!
3+
Thanks for your interest in helping out! Here are a **few** _weird_ tricks to ~~cut your mortgage in half~~ maximize the global net efficiency of your efforts!
54

65
## TL;DR: Checklist
76

@@ -21,33 +20,24 @@ Remember, you don't need to do it all yourself; any of these are helpful! 😎
2120

2221
### Search open + closed issues for similar cases.
2322

24-
You may find an open issue that closely matches what you are thinking. You
25-
may also find a closed issue with discussion that either solves your problem
26-
or explains why we are unlikely to solve it in the near future.
23+
You may find an open issue that closely matches what you are thinking. You may also find a closed issue with discussion that either solves your problem or explains why we are unlikely to solve it in the near future.
2724

28-
If you find a matching issue that is open, and marked `accepted` and/or `help
29-
wanted`, you might want to [open a PR](#prs).
25+
If you find a matching issue that is open, and marked `accepted` and/or `help wanted`, you might want to [open a PR](#prs).
3026

3127
### Open an issue.
3228

33-
Let's discuss your issue. Could be as simple as unclear documentation or a
34-
wonky config file.
35-
If you're suggesting a feature, it might exist and need better
36-
documentation, or it might be in process. Even given those, some discussion might
37-
be warranted to ensure the enhancement is clear.
29+
Let's discuss your issue. Could be as simple as unclear documentation or a wonky config file.
30+
If you're suggesting a feature, it might exist and need better documentation, or it might be in process. Even given those, some discussion might be warranted to ensure the enhancement is clear.
3831

39-
You're welcome to jump right to a PR, but without a discussion, can't make any
40-
guarantees about merging.
32+
You're welcome to jump right to a PR, but without a discussion, can't make any guarantees about merging.
4133

4234
That said: sometimes seeing the code makes the discussion clearer.😄
4335

4436
This is a helpful contribution all by itself. Thanks!
4537

4638
## PRs
4739

48-
If you would like to implement something, firstly: thanks! Community contributions
49-
are a magical thing. Like Redux or [the flux capacitor](https://youtu.be/SR5BfQ4rEqQ?t=2m25s),
50-
they make open source possible.
40+
If you would like to implement something, firstly: thanks! Community contributions are a magical thing. Like Redux or [the flux capacitor](https://youtu.be/SR5BfQ4rEqQ?t=2m25s), they make open source possible.
5141

5242
**Working on your first Pull Request?**
5343
You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
@@ -56,61 +46,26 @@ Here are some things to keep in mind when working on a PR:
5646

5747
#### Tests
5848

59-
A PR that is just failing test cases for an existing issue is very helpful, as this
60-
can take as much time (if not more) as it takes to implement a new feature or fix
61-
a bug.
49+
A PR that is just failing test cases for an existing issue is very helpful, as this can take as much time (if not more) as it takes to implement a new feature or fix a bug.
6250

63-
If you only have enough time to write tests, fantastic! Submit away. This is a great
64-
jumping-off point for a core contributor or even another PR to continue what you've started.
51+
If you only have enough time to write tests, fantastic! Submit away. This is a great jumping-off point for a core contributor or even another PR to continue what you've started.
6552

6653
#### Docs
6754

68-
For enhancements to rules, please update the docs in `docs/rules` matching the rule
69-
filename from `src/rules`.
55+
For enhancements to rules, please update the docs in `docs/rules` matching the rule filename from `src/rules`.
7056

71-
Also, take a quick look at the rule summary in [README.md] in case it could use tweaking,
72-
or add a line if you've implemented a new rule.
57+
Also, take a quick look at the rule summary in [README.md] in case it could use tweaking, or add a line if you've implemented a new rule.
7358

74-
Bugfixes may not warrant docs changes, though it's worth skimming the existing
75-
docs to see if there are any relevant caveats that need to be removed.
59+
Bugfixes may not warrant docs changes, though it's worth skimming the existing docs to see if there are any relevant caveats that need to be removed.
7660

7761
#### Changelog
7862

79-
Please add a quick blurb to the [**Unreleased**](./CHANGELOG.md#unreleased) section of the change log. Give yourself
80-
some credit, and please link back to the PR for future reference. This is especially
81-
helpful for resolver changes, as the resolvers are less frequently modified and published.
63+
Please add a quick blurb to the [**Unreleased**](./CHANGELOG.md#unreleased) section of the change log. Give yourself some credit, and please link back to the PR for future reference. This is especially helpful for resolver changes, as the resolvers are less frequently modified and published.
8264

83-
Note also that the change log can't magically link back to Github entities (i.e. PRs,
84-
issues, users) or rules; there are a handful of footnote URL definitions at the bottom.
85-
You may need to add one or more URL if you've square-bracketed any such items.
65+
Note also that the change log can't magically link back to Github entities (i.e. PRs, issues, users) or rules; there are a handful of footnote URL definitions at the bottom. You may need to add one or more URL if you've square-bracketed any such items.
8666

8767
## Code of Conduct
8868

89-
This is not so much a set of guidelines as a reference for what I hope may become
90-
a shared perspective on the project. I hope to write a longer essay to this end
91-
in the future. Comments are welcome, I'd like this to be as clear as possible.
69+
Please familiarize yourself with the [Code of Conduct](https://github.com/import-js/.github/blob/main/CODE_OF_CONDUCT.md).
9270

93-
### Empathy
94-
95-
People have feelings and perspectives, and people say and believe things for good reasons.
96-
97-
If you find that you summarily disagree with a perspective stated by someone else,
98-
you likely each have histories that have moved you in opposite directions on a continuum
99-
that probably does not have a "wrong" or "right" end. It may be that you simply
100-
are working toward different goals that require different strategies. Every decision
101-
has pros and cons, and could result in some winners and some losers. It's great to
102-
discuss this so that both are well-known, and realize that even with infinite discussion,
103-
cons and losers will likely never go to zero.
104-
105-
Also note that we're not doing brain surgery here, so while it's fine if we spend some time
106-
understanding each other, cordial disagreement should not be expensive in the
107-
long run, and we can accept that we will get some things wrong before we get them right (if ever!).
108-
109-
If we can all get together behind the common goal of embracing empathy, everything else should be able to work itself out.
110-
111-
#### Attribution
112-
113-
Thanks for help from https://mozillascience.github.io/working-open-workshop/contributing/
114-
for inspiration before I wrote this. --ben
115-
116-
[README.md]: ./README.md
71+
[README.md]: ./README.md

0 commit comments

Comments
 (0)