Skip to content

Latest commit

 

History

History
181 lines (116 loc) · 5.47 KB

CONTRIBUTING.md

File metadata and controls

181 lines (116 loc) · 5.47 KB
Raw

MindONE Contributing Guidelines

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Contributor License Agreement

It's required to sign CLA before your first code submission to MindONE community.

For individual contributors, please refer to ICLA online document for detailed information.

Types of Contributions

Report Bugs

Report bugs at https://github.com/mindspore-lab/mindone/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

MindONE could always use more documentation, whether as part of the official MindONE docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/mindspore-lab/mindone/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Getting Started

Ready to contribute? Here's how to set up MindONE for local development.

  1. Fork the mindone repo on GitHub.

  2. Clone your fork locally:

    git clone [email protected]:your_name_here/mindone.git

    After that, you should add the official repository as the upstream repository:

    git remote add upstream [email protected]:mindspore-lab/mindone

  3. Install your local copy into a conda environment. Assuming you have conda installed, this is how you set up your fork for local development:

    conda create -n mindone python=3.8
conda activate mindone
cd mindone
pip install -e .

  4. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass the linters and the tests:

    pre-commit run --show-diff-on-failure --color=always --all-files
pytest

    If all static linting are passed, you will get output like:

    pre-commit-succeed

    otherwise, you need to fix the warnings according to the output:

    pre-commit-failed

    To get pre-commit and pytest, just pip install them into your conda environment.

  6. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
  3. The pull request should work for Python 3.7, 3.8 and 3.9, and for PyPy. Check https://github.com/mindspore-lab/mindone/actions and make sure that the tests pass for all supported Python versions.

Tips

You can install the git hook scripts instead of linting with pre-commit run -a manually.

run flowing command to set up the git hook scripts

pre-commit install

now pre-commit will run automatically on git commit!

Releasing

A reminder for the maintainers on how to deploy.

  1. Make some pull requests, merge all changes from feature branch to master/main.

  2. Update CHANGELOG.md manually. Make sure it follows the Keep a Changelog standard. Be noticed that GitHub workflow will read changelog and extract release notes automatically.

  3. Add the changelog changes:

    git add CHANGELOG.md

  4. Update version number and create a commit, tag(can also be patch or major).

    hatch version patch
git add mindone/version.py
git commit -m "bump version to $(hatch version)"
git tag "v$(hatch version)"

  5. Push these commits to master/main:

    git push

    Before proceeding to the next step, please check workflows triggered by this push have passed.

  6. Push the tags to master/main, creating the new release on both GitHub and PyPI:

    git push --tags

    Only tag name started with 'v'(lower case) will leverage GitHub release workflow.

    Or, if you didn't add a tag in step 4, you can manually create a new release in https://github.com/mindspore-lab/mindone/releases/new. Create a new tag vx.x.x. GitHub Action will then deploy to PyPI if tests pass.

  7. Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly.

  8. Optional. Create new branch vx.x.x if needed.