mirror of
https://github.com/Swiftgram/Telegram-iOS.git
synced 2025-12-24 23:25:38 +00:00
77 lines
2.9 KiB
Markdown
77 lines
2.9 KiB
Markdown
# Contributing to AsyncDisplayKit
|
|
We want to make contributing to this project as easy and transparent as
|
|
possible, and actively welcome your pull requests. If you run into problems,
|
|
please open an issue on GitHub.
|
|
|
|
## Pull Requests
|
|
1. Fork the repo and create your branch from `master`.
|
|
2. If you've added code that should be tested, add tests.
|
|
3. If you've changed APIs, update the documentation.
|
|
4. Ensure the test suite passes.
|
|
5. Make sure your code lints.
|
|
6. If you haven't already, complete the Contributor License Agreement ("CLA").
|
|
7. Make sure that any new files conform to the correct file header style below
|
|
|
|
#### ASDK files header style
|
|
|
|
```
|
|
//
|
|
// ASPagerFlowLayout.h
|
|
// AsyncDisplayKit
|
|
//
|
|
// Created by Levi McCallum on 2/12/16.
|
|
//
|
|
// Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under the BSD-style license found in the
|
|
// LICENSE file in the root directory of this source tree. An additional grant
|
|
// of patent rights can be found in the PATENTS file in the same directory.
|
|
//
|
|
```
|
|
|
|
#### Example project files header style
|
|
|
|
```
|
|
//
|
|
// PhotoCellNode.m
|
|
// Sample
|
|
//
|
|
// Created by Levi McCallum on 2/12/16.
|
|
//
|
|
// Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under the BSD-style license found in the
|
|
// LICENSE file in the root directory of this source tree. An additional grant
|
|
// of patent rights can be found in the PATENTS file in the same directory.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
// FACEBOOK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
//
|
|
```
|
|
|
|
## Contributor License Agreement ("CLA")
|
|
In order to accept your pull request, we need you to submit a CLA. You only need
|
|
to do this once to work on any of Facebook's open source projects.
|
|
|
|
Complete your CLA here: <https://code.facebook.com/cla>
|
|
|
|
## Issues
|
|
We use GitHub issues to track public bugs. Please ensure your description is
|
|
clear and has sufficient instructions to be able to reproduce the issue.
|
|
|
|
Facebook has a [bounty program](https://www.facebook.com/whitehat/) 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.
|
|
|
|
## Getting Help
|
|
We use Slack for real-time debugging, community updates, and general talk about ASDK. Signup at http://asdk-slack-auto-invite.herokuapp.com or email AsyncDisplayKit(at)gmail.com to get an invite.
|
|
|
|
## Coding Style
|
|
* 2 spaces for indentation rather than tabs
|
|
|
|
## License
|
|
By contributing to AsyncDisplayKit, you agree that your contributions will be
|
|
licensed under its BSD license.
|