Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

64 lines (39 loc) · 3.66 KB
Raw

Contributing Guide

The following opendatahub-io/ai-edge GitHub Project board is the source of truth for the work taking place in this repo. You can pick up an issue from the TO DO column and follow the workflow described below.


image


Issues with the Tracker label are the high-level longer-term tasks for the PoC, with smaller “Sub Tasks” often listed in the description that should be completed to achieve this goal. These link to other GitHub issues.


image


Typical Workflow

The easiest way to start contributing is to work on these smaller “Sub Tasks”.


NOTE By contributing you agree to the license terms (see LICENSE).


The general flow of making contributions to the repo goes like this:

  • Choose an issue to work on.

  • Assign it to yourself.

  • If the description is not very detailed, you can improve it yourself. Add a suitable description, link to a User Story, and add acceptance criteria (see next page).

  • Add labels and other details e.g. the priority and kind/documentation if you will be adding documentation or modifying existing README files.

  • If there is a roadblock to completing the issue, reach out on the relevant OpenDataHub Slack channels (invite). Someone will gladly try to help.

    • Sometimes a task or user story ends up not being fully possible to achieve, at least in the way it was intended (like in this case). This is okay, make sure to reach out to others for help instead of trying to do the impossible.

  • If your work involves coding (which it probably does) please use the following Git approach:

    • Make a fork of the opendatahub-io/ai-edge repo.

    • Create a new branch with a suitable name that describes your work.

    • Create and push commits regularly to save your progress.

    • When you’re ready to make a pull request with your changes, first clean-up by rebasing and squashing the commits. Make sure to use clear and descriptive commit messages.

    • Create the pull request, apply the appropriate labels, and link the relevant GitHub issue to it. Also make sure to include a good description of your changes and screenshots if appropriate.

    • Wait for other members of the team to review your work, you can also tag team members who you think are relevant to your work.

    • Once any conflicts and code suggestions have been resolved, and your work has been approved, you can merge the pull request or wait for somebody else to merge it for you.


Examples


Typical “Sub Task” GitHub issue:

image


Typical Pull Request:

image