Atlas Contributing Guide

Welcome to create Pull Requests or open Issues for bugfix, doc, example, suggestion and anything.

Branch Management

master
 ↑
dev         <--- PR(hotfix/typo/3rd-PR)
 ↑ PR
{domain}-feature-{date}

Atlas Branches

master branch
1. master is the latest (pre-)release branch.
dev branch
1. dev is the stable developing branch. Github Release is used to publish a (pre-)release version to master branch.
2. It’s RECOMMENDED to commit hotfix (like typo) or feature PR to dev.
{domain}-feature-{date} branch
1. The branch for a developing iteration, e.g. core-feature-20170118 is an atlas-core developing iteration which is done at 2017.01.18. {domain} consists of core, update, plugin and aapt.
2. DO NOT commit any PR to such a branch.

{module}-{action}-{shortName}

{module}, see commit log module
{action}
- feature: checkout from {module} and merge to {module} later. If {module} not exists, merge to dev
- bugfix: like feature, for bugfix only
- hotfix: checkout from master or release tag, merge to master and {module} later. If {module} not exists, merge to dev

for example:

[{module}] {description}

{module}
- Including: atlas-core, atlas-aapt, atlas-update, atlas-gradle-plugin, atlas-doc, atlas-website, atlas-demo, test, all
{description}
- It’s RECOMMENDED to close issue with syntax close #66 or fix #66, see the doc for more detail. It’s useful for responding issues.

for example:

In order to contribute code to Atlas, you (or the legal entity you represent) must sign the Contributor License Agreement (CLA).

You can read and sign the Alibaba CLA online.

For CLA assistant service works properly, please make sure you have added email address that your commits linked to GitHub account.