Skip to content

Commit 0e2630b

Browse files
authored
docs: Update CONTRIBUTING guide (#1707)
1 parent b6ec05c commit 0e2630b

File tree

1 file changed

+42
-65
lines changed

1 file changed

+42
-65
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,49 @@
1-
# Contributing to the Parse SDK for iOS/OS X
2-
We want to make contributing to this project as easy and transparent as possible.
3-
4-
## Our Development Process
5-
6-
### `master` is unsafe
7-
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 specific releases in any production environment.
8-
9-
### Pull Requests
10-
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.
11-
12-
#### 1. Fork the repo and create your branch from `master`.
13-
14-
#### 2. Add unit tests for any new code you add.
15-
- Main SDK - [/Parse/Tests/Unit/](/Parse/Tests/Unit/)
16-
- Facebook Utils - [/ParseFacebookUtils/Tests/Unit/](/ParseFacebookUtils/Tests/Unit/)
17-
- Twitter Utils - [/ParseTwitterUtils/Tests/Unit/](/ParseTwitterUtils/Tests/Unit/)
18-
19-
#### 3. If you've changed APIs, update the documentation and the [iOS Guide](https://github.com/parse-community/docs/tree/gh-pages/_includes/ios)
20-
21-
#### 4. Ensure the test suite passes.
22-
You can run the tests in the command line with rake.
23-
24-
Install all dependencies:
25-
```
26-
git submodule update --init --recursive
27-
gem install bundler
28-
bundle install
29-
```
30-
Run the tests:
31-
```
32-
bundle exec rake test:ios
33-
```
34-
Check the Rakefile and the circleci config for more information.
1+
# Contributing to the Parse Apple SDK <!-- omit in toc -->
2+
3+
- [Contributing](#contributing)
4+
- [Bugs](#bugs)
5+
- [Known Issues](#known-issues)
6+
- [Reporting Issues](#reporting-issues)
7+
- [Security Bugs](#security-bugs)
8+
- [Code of Conduct](#code-of-conduct)
9+
10+
# Contributing
11+
12+
For analyzing bugs, creating bug fixes and features we recommend to clone this repository locally and add it as a local package to your Xcode project. This way you can edit and inspect the Parse SDK while running your app. You can find step-by-step instructions for how do that in the [Xcode docs](https://developer.apple.com/documentation/xcode/editing-a-package-dependency-as-a-local-package).
13+
14+
1. Fork the repository and create a new branch.
15+
2. Add unit tests for any new code you add.
16+
- Core Module - [/Parse/Tests/Unit/](/Parse/Tests/Unit/)
17+
- Facebook Utils - [/ParseFacebookUtils/Tests/Unit/](/ParseFacebookUtils/Tests/Unit/)
18+
- Twitter Utils - [/ParseTwitterUtils/Tests/Unit/](/ParseTwitterUtils/Tests/Unit/)
19+
3. If you've changed APIs, update the documentation and the [iOS Guide](https://github.com/parse-community/docs/tree/gh-pages/_includes/ios).
20+
4. Ensure the test suite passes.
21+
You can run the tests in the command line with rake.
22+
23+
Install all dependencies:
24+
```
25+
git submodule update --init --recursive
26+
gem install bundler
27+
bundle install
28+
```
29+
Run the tests:
30+
```
31+
bundle exec rake test:ios
32+
```
33+
Check the Rakefile and the circleci config for more information.
3534

36-
#### 5. Make sure your code follows the [style guide](#style-guide)
37-
38-
### Preparing for a new release
39-
40-
#### Update the version number
35+
5. Make sure your code follows the [style guide](#style-guide).
4136

42-
You can use the rake task in order to bump the version number, it's safe, and will properly update all version numbers
37+
# Bugs
4338

44-
```
45-
$ bundle exec rake package:set_version[X.X.X]
46-
```
39+
Although we try to keep developing with the Parse Platform easy, you still may run into some issues. General questions should be asked in our [community forum](community-forum), technical questions should be asked on [Stack Overflow][stack-overflow], and for everything else we use GitHub issues.
4740

48-
Note that zsh users (such as those using macOS >= 10.15) need to escape the brackets as follows:
41+
## Known Issues
4942

50-
```
51-
$ bundle exec rake package:set_version\[X.X.X\]
52-
```
53-
54-
Replace X.X.X by the version number and push to the repository.
55-
56-
## Bugs
57-
Although we try to keep developing with the Parse Platform easy, you still may run into some issues. General questions should be asked on our [community forum](community-forum), technical questions should be asked on [Stack Overflow][stack-overflow], and for everything else we use GitHub issues.
58-
59-
### Known Issues
6043
We use GitHub issues to track public bugs. We keep a close eye on this and try to make it clear when a fix is in progress. Before filing a new issue, check existing issues for the same problem.
6144

62-
### Reporting New Issues
45+
## Reporting Issues
46+
6347
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 Dashboard API Console. If it does, you can [report bugs on the Parse Server repository](https://github.com/parse-community/parse-server/issues/new/choose).
6448

6549
To view the REST API network requests issued by the Parse SDK, please check out our [Network Debugging Tool][network-debugging-tool].
@@ -73,19 +57,12 @@ Details are key. The more information you provide us the easier it'll be for us
7357
* Anything else you find relevant.
7458

7559

76-
### Security Bugs
77-
Please follow our [security documentation](https://github.com/parse-community/.github/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.
60+
## Security Bugs
7861

79-
## Style Guide
80-
We're still working on providing a code style for your IDE and getting a linter on GitHub, but for now try to keep the following:
81-
82-
* Most importantly, match the existing code style as much as possible.
83-
* Try to keep lines under 120 characters, if possible.
84-
85-
## License
86-
By contributing to Parse iOS/OSX SDK, you agree that your contributions will be licensed under its license.
62+
Please follow our [security documentation](https://github.com/parse-community/.github/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.
8763

8864
# Code of Conduct
65+
8966
This project adheres to the [Contributor Covenant Code of Conduct](https://github.com/parse-community/.github/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to honor this code.
9067

9168
[stack-overflow]: http://stackoverflow.com/tags/parse-platform

0 commit comments

Comments
 (0)