Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 3.26 KB
Raw

Contributing to coobjc

We love contributions to the coobjc project and request you follow the guidelines below. If you have any questions, or need any help, open an ISSUE.

Table of Contents

Getting Started

To get started, you will need to open a Terminal and:

  1. Fork this repo and clone it onto your machine.

    $ git clone https://github.com/YOUR_GITHUB_ID/git@github.com:alibaba/coobjc.git

  2. Make changes to code, usually by tackling an issue. A list of issues can be found ISSUE.

    If there aren't any tagged issues, open a Feature ISSUE.

  3. All source code submitted requires an Apache License header at the top of the file. This text can be found Here, just copy and paste it at the top of any new files you're submitting.

  1. Commit message should conform to commit message templates.

  2. If the tests all pass, open a Pull Request following the guidelines below.

Pull Requests

When opening a PR, please:

  1. Create minimal differences and do not reformat the code. If you feel the codes structure needs changing, open a separate PR.
  2. Check for unnecessary white space using git diff --check before you commit your code.
  3. Squash all commit as one on feature branch.

Asking Questions

If you have any questions, Comment on existing issues, or raise new ones if you discover something.

Reporting Issues

See the issue template.

Additional Resources