Skip to content

docs: Update CONTRIBUTING guide #1707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2023
Merged

docs: Update CONTRIBUTING guide #1707

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 42 additions & 65 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,49 @@
# Contributing to the Parse SDK for iOS/OS X
We want to make contributing to this project as easy and transparent as possible.

## Our Development Process

### `master` is unsafe
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.

### Pull Requests
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.

#### 1. Fork the repo and create your branch from `master`.

#### 2. Add unit tests for any new code you add.
- Main SDK - [/Parse/Tests/Unit/](/Parse/Tests/Unit/)
- Facebook Utils - [/ParseFacebookUtils/Tests/Unit/](/ParseFacebookUtils/Tests/Unit/)
- Twitter Utils - [/ParseTwitterUtils/Tests/Unit/](/ParseTwitterUtils/Tests/Unit/)

#### 3. If you've changed APIs, update the documentation and the [iOS Guide](https://github.com/parse-community/docs/tree/gh-pages/_includes/ios)

#### 4. Ensure the test suite passes.
You can run the tests in the command line with rake.

Install all dependencies:
```
git submodule update --init --recursive
gem install bundler
bundle install
```
Run the tests:
```
bundle exec rake test:ios
```
Check the Rakefile and the circleci config for more information.
# Contributing to the Parse Apple SDK <!-- omit in toc -->

- [Contributing](#contributing)
- [Bugs](#bugs)
- [Known Issues](#known-issues)
- [Reporting Issues](#reporting-issues)
- [Security Bugs](#security-bugs)
- [Code of Conduct](#code-of-conduct)

# Contributing

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).

1. Fork the repository and create a new branch.
2. Add unit tests for any new code you add.
- Core Module - [/Parse/Tests/Unit/](/Parse/Tests/Unit/)
- Facebook Utils - [/ParseFacebookUtils/Tests/Unit/](/ParseFacebookUtils/Tests/Unit/)
- Twitter Utils - [/ParseTwitterUtils/Tests/Unit/](/ParseTwitterUtils/Tests/Unit/)
3. If you've changed APIs, update the documentation and the [iOS Guide](https://github.com/parse-community/docs/tree/gh-pages/_includes/ios).
4. Ensure the test suite passes.
You can run the tests in the command line with rake.

Install all dependencies:
```
git submodule update --init --recursive
gem install bundler
bundle install
```
Run the tests:
```
bundle exec rake test:ios
```
Check the Rakefile and the circleci config for more information.

#### 5. Make sure your code follows the [style guide](#style-guide)

### Preparing for a new release

#### Update the version number
5. Make sure your code follows the [style guide](#style-guide).

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

```
$ bundle exec rake package:set_version[X.X.X]
```
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.

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

```
$ bundle exec rake package:set_version\[X.X.X\]
```

Replace X.X.X by the version number and push to the repository.

## Bugs
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.

### Known Issues
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.

### Reporting New Issues
## Reporting Issues

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).

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


### Security Bugs
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.
## Security Bugs

## Style Guide
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:

* Most importantly, match the existing code style as much as possible.
* Try to keep lines under 120 characters, if possible.

## License
By contributing to Parse iOS/OSX SDK, you agree that your contributions will be licensed under its license.
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.

# Code of Conduct

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.

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