The best way to know more about contributing and how to get started is to join us on Slack and ask questions in our public channels.
Thanks for your interest in contributing to Jina. We're grateful for your initiative! ❤️
I'm Alex C-G, Open Source Evangelist for Jina. I'm all about getting our new contributors up-to-speed, and that's what we'll do below.
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
- 🥇 Making Your First Submission
- ☑️ Naming Conventions
- 💥 Testing Jina Locally and on CI
- 📖 Contributing Documentation
- 🙏 Thank You
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: You can find this with `jina -vf
- Screenshots: If they're relevant
To understand how our issues are labeled, check out our issue label guide.
- Associate your local git config with your github account. If this is your first time using git you can follow the steps.
- Fork the Jina repo and clone onto your computer.
- Configure git pre-commit hooks. Please follow the steps
- Create a new branch, for example
fix-jina-typo-1. - Work on this branch to do the fix/improvement.
- Check if your code changes follow the code review guidelines.
- Commit the changes with the correct commit style.
- Make a pull request.
- Submit your pull request and wait for all checks to pass.
- Request reviews from one of the code owners.
- 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.
- Confirm username and email on your profile page.
- Set git config on your computer.
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 --forceWhat happens after the merge? Understand the development stage and release cycles here.
In Jina we use git's pre-commit hooks in order to make sure the code matches our standards of quality and documentation. At the moment we employ them for checking the style and the docstrings of the code. Documentation of code is crucial to maintaining productive developers and clear communication with new users. We also want to reduce all arguments about code styling.
It's easy to configure it:
pip install pre-commitpre-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.
For more about our docstring style, refer to this guide.
Run git config blame.ignoreRevsFile .github/.git-blame-ignore-revs
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.
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: 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 semi-colons, etc)
- test: Adding missing tests or correcting existing tests
- chore: updating grunt tasks etc; no production code change
Your branch name should follow the format type-scope(-issue_id):
typeis one of the types abovescopeis optional, and represents the module your branch is working on.issue_idis 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 |
A good commit message helps us track Jina'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:
typeis one of the types above.scopeis optional, and represents the module your commit is working on.subjectexplains 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 for flow exception |
Should be test(flow) |
DOC(101): Improved 101 Documentation |
All letters should be in lowercase |
fix(pea): i fix this pea and this looks really awesome and everything should be working now |
Too long |
fix(pea):fix network receive of the pea |
Missing space after : |
hello: add hello-world |
Type hello is not allowed |
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>" | commitlintWe 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.
You need to build a local docker image tagged 'jinaai/jina:test-pip' for all the tests to run as in the CI, via:
docker build --build-arg PIP_TAG="[devel]" -f ${PATH_TO_JINA}/Dockerfiles/pip.Dockerfile -t jinaai/jina:test-pip ${PATH_TO_JINA}Locally you can do unittest via:
pip install ".[test]"
pytest -v -s --ignore-glob='tests/integration/hub_usage/dummyhub*' testsWhen you add an executor or a driver, you may introduce new dependencies to Jina. You can verify the dependencies via:
jina check, and via Docker container:
docker run jinaai/jina:my-local-version checkIt prints a list of components the current version of Jina supports, and then exits. Make sure yours are not in red.
Once you submit the PR, your code will be tested in the environment of Python 3.7 and 3.8 with full extra dependencies (pip install .[all]) installed.
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
Once again, thanks so much for your interest in contributing to Jina. We're excited to see your contributions!