Skip to content

Commit 4eea6c6

Browse files
committed
Updates readme and adds contributing guide
1 parent 2fd4f71 commit 4eea6c6

File tree

2 files changed

+57
-2
lines changed

2 files changed

+57
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing
2+
3+
Thanks for choosing to contribute!
4+
5+
The following are a set of guidelines to follow when contributing to this project.
6+
7+
## Code Of Conduct
8+
9+
This project adheres to the Adobe [code of conduct](../CODE_OF_CONDUCT.md). By participating,
10+
you are expected to uphold this code. Please report unacceptable behavior to
11+
[Grp-opensourceoffice@adobe.com](mailto:Grp-opensourceoffice@adobe.com).
12+
13+
## Have A Question?
14+
15+
Start by filing an issue. The existing committers on this project work to reach
16+
consensus around project direction and issue solutions within issue threads
17+
(when appropriate).
18+
19+
## Contributor License Agreement
20+
21+
All third-party contributions to this project must be accompanied by a signed contributor
22+
license agreement. This gives Adobe permission to redistribute your contributions
23+
as part of the project. [Sign our CLA](https://opensource.adobe.com/cla.html). You
24+
only need to submit an Adobe CLA one time, so if you have submitted one previously,
25+
you are good to go!
26+
27+
## Code Reviews
28+
29+
All submissions should come in the form of pull requests and need to be reviewed
30+
by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/)
31+
for more information on sending pull requests.
32+
33+
Lastly, please follow the [pull request template](PULL_REQUEST_TEMPLATE.md) when
34+
submitting a pull request!
35+
36+
## From Contributor To Committer
37+
38+
We love contributions from our community! If you'd like to go a step beyond contributor
39+
and become a committer with full write access and a say in the project, you must
40+
be invited to the project. The existing committers employ an internal nomination
41+
process that must reach lazy consensus (silence is approval) before invitations
42+
are issued. If you feel you are qualified and want to get more deeply involved,
43+
feel free to reach out to existing committers to have a conversation about that.
44+
45+
## Security Issues
46+
47+
Security issues shouldn't be reported on this issue tracker. Instead, [file an issue to our security experts](https://helpx.adobe.com/security/alertus.html).

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
An Apollo link that enqueues mutations so that they do not fire in parallel.
44

5-
## Why
5+
## Goals
66

77
I was finding that mutations affecting the same underlying data would often
88
return incorrect data if fired in parallel. Instead of blocking UI based on the
99
loading state of the mutations I wrote a link that just enqueues mutations.
1010

11-
## Use
11+
### Usage
1212

1313
Compose your link chain with the link.
1414

@@ -43,3 +43,11 @@ useEffect(() => {
4343
});
4444
}, []);
4545
```
46+
47+
### Contributing
48+
49+
Contributions are welcomed! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.
50+
51+
### Licensing
52+
53+
This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.

0 commit comments

Comments
 (0)