Skip to content

Latest commit

 

History

History
68 lines (52 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

68 lines (52 loc) · 2.2 KB
Raw

Contributing guidelines

Contributors are welcome to submit their code and ideas. In a long run, we hope this project can be managed by developers from both inside and outside Alibaba.

Contributor License Agreements

  • Sign CLA of EasyDist: Please download EasyDist CLA. Follow the instructions to sign it.

Pull Request Checklist

Here is a checklist to prepare and submit your PR (pull request).

  • Create your own Github branch by forking EasyDist.
  • Read the README.
  • Read the contributing guidelines.
  • Read the Code of Conduct.
  • Ensure you have signed the Contributor License Agreement (CLA).
  • Push changes to your personal fork.
  • Create a PR with a detail description, if commit messages do not express themselves.
  • Submit PR for review and address all feedbacks.
  • Wait for merging (done by committers).

Let's use an example to walk through the list.

An Example of Submitting Code Change to EasyDist

Fork Your Own Branch

On Github page of EasyDist, Click fork button to create your own easydist repository.

Create Local Repository

git clone --recursive https://github.com/your_github/easydist.git

Create a dev Branch (named as your_github_id_feature_name)

git branch your_github_id_feature_name

Make Changes and Commit Locally

git status
git add files-to-change
git commit -m "messages for your modifications"

Rebase and Commit to Remote Repository

git checkout main
git pull
git checkout your_github_id_feature_name
git rebase main
-- resolve conflict, run test --
git push --recurse-submodules=on-demand origin your_github_id_feature_name

Create a PR

Click New pull request or Compare & pull request button, choose to compare branches easydist/main and your_github/your_github_id_feature_name, and write PR description.

Address Reviewers' Comments

Resolve all problems raised by reviewers and update PR.

Merge

It is done by EasyDist committers.

Copyright © Alibaba Group, Inc.