Skip to content

Commit ac11290

Browse files
authored
Update CONTRIBUTING.md (#1244)
Fixed line breaks for MarkDown rule.
1 parent ce2a0c3 commit ac11290

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Contributing to the Parse JavaScript SDK
2+
23
We want to make contributing to this project as easy and transparent as possible.
34

45
If you're looking to get started, but want to ease yourself into the codebase, look for issues tagged [good first task](https://github.com/parse-community/Parse-SDK-JS/labels/good%20first%20task). These are simple yet valuable tasks that should be easy to get started.
56

67
## `master` is unsafe
8+
79
Our goal is to keep `master` stable, but there may be changes that your application may not be compatible with. We'll do our best to publicize any breaking changes, but try to use our specific releases in any production environment.
810

911
## Setting up the project for debugging and contributing:
@@ -63,6 +65,7 @@ To run the integration tests, you will need a valid mongodb running on your loca
6365
Use `npm run integration` in order to run the integration tests. If you have the vscode Jasmine extension installed (as recommended), you can run your tests by clicking the *Run* or the *Debug* lens that appears near by the test.
6466

6567
### Pull Requests
68+
6669
We actively welcome your pull requests. When we get one, we'll run some Parse-specific integration tests on it first. From here, we'll need to get a core member to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.
6770

6871
1. Fork the repo and create your branch from `master`.
@@ -72,9 +75,11 @@ We actively welcome your pull requests. When we get one, we'll run some Parse-sp
7275
5. Make sure your code lints.
7376

7477
### Known Issues
78+
7579
We use GitHub issues to track public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.
7680

7781
### Reporting New Issues
82+
7883
Not all issues are SDK issues. If you're unsure whether your bug is with the SDK or backend, you can test to see if it reproduces with our [REST API][rest-api] and [Parse API Console][parse-api-console]. If it does, you can report backend bugs [here][bug-reports].
7984
If the issue only reproduces with the JS SDK, you can [open an issue](https://github.com/parse-community/parse-server/issues) on this repository.
8085

@@ -87,9 +92,11 @@ Details are key. The more information you provide us the easier it'll be for us
8792
* Anything else you find relevant.
8893

8994
### Security Bugs
95+
9096
Parse Community has a [responsible Vulnerability Disclosure Program](https://github.com/parse-community/parse-server/blob/master/SECURITY.md) for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
9197

9298
## Coding Style
99+
93100
* Most importantly, match the existing code style as much as possible.
94101
* We use [Flow](http://flowtype.org/) and ES6 for this codebase. Use modern syntax whenever possible.
95102
* Keep lines within 80 characters.
@@ -100,6 +107,7 @@ Parse Community has a [responsible Vulnerability Disclosure Program](https://git
100107
This project adheres to the [Contributor Covenant Code of Conduct](https://github.com/parse-community/parse-server/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to honor this code.
101108

102109
## License
110+
103111
By contributing to the Parse JavaScript SDK, you agree that your contributions will be licensed under its license.
104112

105113
[google-group]: https://groups.google.com/forum/#!forum/parse-developers

0 commit comments

Comments
 (0)