Skip to content

Commit b076d7b

Browse files
authored
Update contributors doc (facebookarchive#1009)
* Add Code of Conduct to CONTRIBUTING doc Good stuff. Snagged from the [React 'How to Contribute'](https://facebook.github.io/react/contributing/how-to-contribute.html) page. * Add stability philosophy to CONTRIBUTING doc To address questions and concerns we have had internally and externally about API changes. * Fix missing newline Thanks to @existentialism for catching this.
1 parent 9dbcb69 commit b076d7b

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
We want to make contributing to this project as easy and transparent as
33
possible.
44

5+
## Code of Conduct
6+
Facebook has adopted a Code of Conduct that we expect project
7+
participants to adhere to. Please [read the full text](https://code.facebook.com/codeofconduct)
8+
so that you can understand what actions will and will not be tolerated.
9+
510
## Our Development Process
611
We use GitHub to sync code to and from our internal repository. We'll use GitHub
712
to track issues and feature requests, as well as accept pull requests.
@@ -37,6 +42,18 @@ outlined on that page and do not file a public issue.
3742
* 80 character line length
3843
* Run `npm run lint` to conform to our lint rules
3944

45+
## Stability
46+
Our philosophy regarding API changes is as follows:
47+
* We will avoid changing APIs and core behaviors in general
48+
* In order to avoid stagnation we will allow for API changes in cases where
49+
there is no other way to achieve a high priority bug fix or improvement.
50+
* When there is an API change:
51+
* Changes will have a clearly documented reason and migration path
52+
* When deprecating a pattern, these steps will be followed:
53+
* We will test the change internally first at FB
54+
* A version will be released that supports both, with deprecation warnings
55+
* The following version will fully remove the deprecated pattern
56+
4057
## License
4158
By contributing to Draft.js, you agree that your contributions will be licensed
4259
under its BSD license.

0 commit comments

Comments
 (0)