Skip to content

Latest commit

 

History

History
306 lines (212 loc) · 13.3 KB

CONTRIBUTING.md

File metadata and controls

306 lines (212 loc) · 13.3 KB
Raw

Contributing to DocArray

Thanks for your interest in contributing to DocArray. We're grateful for your initiative! ❤️

In this guide, we're going to go through the steps for each kind of contribution, and good and bad examples of what to do. We look forward to your contributions!

🐞 Bugs and Issues

Submitting Issues

We love to get issue reports. But we love it even more if they're in the right format. For any bugs you encounter, we need you to:

  • Describe your problem: What exactly is the bug. Be as clear and concise as possible
  • Why do you think it's happening? If you have any insight, here's where to share it

There are also a couple of nice to haves:

  • Environment: Operating system, DocArray version, python version,...
  • Screenshots: If they're relevant

🥇 Making Your First Submission

  1. Associate your local git config with your GitHub account. If this is your first time using git you can follow the steps.
  2. Fork the DocArray repo and clone onto your computer.
  3. Configure git pre-commit hooks. Please follow the steps
  4. Create a new branch, for example fix-docarray-typo-1.
  5. Work on this branch to do the fix/improvement.
  6. Commit the changes with the correct commit style.
  7. Make a pull request.
  8. Submit your pull request and wait for all checks to pass.
  9. Request reviews from one of the code owners.
  10. Get a LGTM 👍 and PR gets merged.

Note: If you're just fixing a typo or grammatical issue, you can go straight to a pull request.

Associate with GitHub Account

git config user.name "YOUR GITHUB NAME"
git config user.email "YOUR GITHUB EMAIL"
  • (Optional) Reset the commit author if you made commits before you set the git config.
git checkout YOUR-WORKED-BRANCH
git commit --amend --author="YOUR-GITHUB-NAME <YOUR-GITHUB-EMAIL>" --no-edit
git log  # to confirm the change is effective
git push --force

Install pre-commit hooks

In DocArray we use git's pre-commit hooks in order to make sure the code matches our standards of quality and documentation. It's easy to configure it:

  1. pip install pre-commit
  2. pre-commit install

Now you will be automatically reminded to add docstrings to your code. black will take care that your code will match our style. Note that black will fail your commit but reformat your code, so you just need to add the files again and commit again.

Restoring correct git blame

Run git config blame.ignoreRevsFile .github/.git-blame-ignore-revs

📝 Code style conventions:

Most of our codebase is written in Python.

PEP compliance

We comply to the official PEP: E9, F63, F7, F82 code style and required every contribution to follow it. This is enforced by using flake8 in our CI and in our pre-commit hooks.

Python version

DocArray is compatible with Python 3.7 and above, therefore we can't accept contribution that used features from the newest Python versions without ensuring compatibility with python 3.7

Code formatting

All of our Python codebase follows formatting standard. We are following the PEP8 standard, and we require that every code contribution is formatted using black with the default configurations. If you have installed the pre-commit hooks the formatting should be automatic on every commit. Moreover, our CI will block contributions that do not respect these conventions.

Type Hint

Python is not a strongly typed programming language, nevertheless the use of type hints
contribute to a better codebase especially when reading, reviewing and refactoring. Therefore, we highly encourage every contribution to fully utilise type hints. In some particular cases type hints can be cumbersome, therefore using type hints is not a hard requirement for contribution.

Contributions are expected to use type hints, especially in function signature, unless there is an arguably good reason not to do it.

Note: Example code in the documentation should also follow our code style conventions

☑️ Naming Conventions

For branches, commits, and PRs we follow some basic naming conventions:

  • Be descriptive
  • Use all lower-case
  • Limit punctuation
  • Include one of our specified types
  • Short (under 70 characters is best)
  • In general, follow the Conventional Commit guidelines

Note: If you don't follow naming conventions, your commit will be automatically flagged to be fixed.

Specify the correct types

Type is an important prefix in PR, commit message. For each branch, commit, or PR, we need you to specify the type to help us keep things organized. For example,

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: build, ci, chore, docs, feat, fix, refactor, style, or test.
  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
  • test: Adding missing tests or correcting existing tests
  • chore: updating grunt tasks etc.; no production code change

Naming your Branch

Your branch name should follow the format type-scope(-issue_id):

  • type is one of the types above
  • scope is optional, and represents the module your branch is working on.
  • issue_id is the GitHub issue number. Having the correct issue number will automatically link the Pull Request on this branch to that issue.

Good examples:

fix-executor-loader-113
chore-update-version
docs-add-cloud-section-33

Bad examples:

Branch name Feedback
FIXAWESOME123 Not descriptive enough, all caps, doesn't follow spec
NEW-test-1 Should be lower case, not descriptive
mybranch-1 No type, not descriptive

Writing your Commit Message

A good commit message helps us track DocArray's development. A Pull Request with a bad commit message will be rejected automatically in the CI pipeline.

Commit messages should stick to our naming conventions outlined above, and use the format type(scope?): subject:

  • type is one of the types above.
  • scope is optional, and represents the module your commit is working on.
  • subject explains the commit, without an ending period.

For example, a commit that fixes a bug in the executor module should be phrased as: fix(executor): fix the bad naming in init function

Good examples:

fix(indexer): fix wrong sharding number in indexer
feat: add remote api

Bad examples:

Commit message Feedback
doc(101): improved 101 document Should be docs(101)
tests(flow): add unit test to document array Should be test(array)
DOC(101): Improved 101 Documentation All letters should be in lowercase
fix(pea): i fix this issue and this looks really awesome and everything should be working now Too long
fix(array):fix array serialization Missing space after :
hello: add hello-world Type hello is not allowed

DCO and Signed commit

Commit need to be signed. Indeed the DocArray repo enforce the Developer Certificate of Origin via the DCO github app

To do so you need to use the -s argument when commiting:

git commit -m -s 'feat: add a new feature'

What if I Mess Up?

We all make mistakes. GitHub has a guide on rewriting commit messages so they can adhere to our standards.

You can also install commitlint onto your own machine and check your commit message by running:

echo "<commit message>" | commitlint

Naming your Pull Request

We don't enforce naming of PRs and branches, but we recommend you follow the same style. It can simply be one of your commit messages, just copy/paste it, e.g. fix(readme): improve the readability and move sections.

💥 Testing DocArray Locally and on CI

Locally you can do unittest via:

pip install ".[test]"
pytest -v -s tests

Test policy

Every contribution that adds or modifies the behavior of a feature must include a suite of tests that validates that the feature works as expected.

This allows:

  • the reviewer to be very confident that the feature does what it is supposed to do before merging it into the code base
  • the contributors to be sure that they don't break already-merged features when refactoring or modifying the code base.

📖 Contributing Documentation

Good docs make developers happy, and we love happy developers! We've got a few different types of docs:

  • General documentation
  • Tutorials/examples
  • Docstrings in Python functions in RST format - generated by Sphinx

Documentation guidelines

  1. Decide if your page is a guide or a tutorial. Make sure it fits its section.
  2. Use “you” instead of “we” or “I”. It engages the reader more.
  3. Sentence case for headers. (Use https://convertcase.net/ to check)
  4. Keep sentences short. If possible, fewer than 13 words.
  5. Only use backticks for direct references to code elements.
  6. All acronyms should be UPPERCASE (Ex. YAML, JSON, HTTP, SSL).
  7. Think about the structure of the page beforehand. Split it into headers before writing the content.
  8. If relevant, include a “See also” section at the end.
  9. Link to any existing explanations of the concepts you are using.

Bonus: Know when to break the rules. Documentation writing is as much art as it is science. Sometimes you will have to deviate from these rules in order to write good documentation.

MyST Elements Usage

  1. Use the {tab} element to show multiple ways of doing one thing. Example
  2. Use the {admonition} boxes with care.
  3. Use {dropdown} to hide optional content, such as long code snippets or console output.

Note: Example code in the documentation should also follow our code style conventions that you can find above

Building documentation on your local machine

Requirements

  • Python 3
  • jq

Steps to build locally

cd docs
pip install -r requirements.txt
export NUM_RELEASES=10
bash makedoc.sh local-only

Docs website will be generated in _build/dirhtml To serve it, run

cd _build/dirhtml
python -m http.server

You can now see docs website on http://localhost:8000 on your browser.

🙏 Thank You

Once again, thanks so much for your interest in contributing to DocArray. We're excited to see your contributions!