Contributing to WebUI-Vue

:+1::tada: First off, thanks for taking the time to contribute! :+1::tada:

The following is a set of guidelines for contributing to the OpenBMC Web UI.

Table of contents

Project Setup

Set up Gerrit account

The OpenBMC projects use Gerrit for code review. Use the OpenBMC Gerrit Setup/Integration guidelines to set up your Gerrit account.

Clone repo from Gerrit

Since we use Gerrit to manage all the code contributions, it is not necessary to create a fork from GitHub. Read more about submitting a code review in the Code Reviews section below.

  1. Visit https://gerrit.openbmc-project.xyz/admin/repos/openbmc/webui-vue
  2. Clone the repo using the Clone with commit-msg hook link
    • Windows users may need to separate the two commands depending on if they have installed a Bash emulator like Git for Windows or CMDER or installed the Windows Subsystem for Linux.

Install Dependencies

npm install

Create a .env file

  1. Create the following file in the root directory
    • .env.development.local
  2. Add the following environment variable
    • BASE_URL="https://"`

Compile and hot-reload for development

npm run serve

Run Documentation Locally (Vuepress static site generation)

npm run docs:serve

Run unit tests

npm run test:unit

Lint and fix files

npm run lint

This project and everyone participating are required to follow the OpenBMC Code of Conduct.

Asking Questions

The OpenBMC communicates using a mail list and the Discord channel. Although you could create a GitHub issue to ask a question, a better option would be to ask your question using the email list or Discord channel.

Submitting Bugs

Before submitting an issue, please search through the existing GitHub issues to see if someone already reported the problem. If the issue does not exist, use the Bug report template to report the problem.

Before submitting a request for a new feature, please search through the existing GitHub issues. If no one has suggested the idea previously, use the Feature request template to submit a new feature request.

User Research

To improve the OpenBMC Web UI, we are actively seeking end-user feedback through the IBM Design Partner program.

What is an OpenBMC Design Partner?

Contribute your feedback and bring your domain expertise to help us improve the OpenBMC GUI. The time commitment is minimal: 1-hour feedback sessions conducted remotely via Webex, 1 to 2 times per month. Activities may include exploratory interviews, participatory design, periodic surveys, or usability testing sessions.

Note: IBM requires all user research participants to sign a Feedback Program Agreement (FPA), describing how IBM complies with the latest GDPR guidelines. The FPA only needs to be signed once to cover your company or entity's participation.

Design Reviews

When making changes to an existing design, we create a design review issue in GitHub. We then send an email to the community and review the changes in the OpenBMC GUI Design Workgroup.

Help Wanted

New features and bugs ready for development will be tagged with the Help Wanted tag and added to the Help Wanted Project. If you want to pick up a story, add a comment stating your interest, and a maintainer will assign the story and move it to the In Progress column in the Project Kanban board.

Code Reviews

The OpenBMC project uses Gerrit for all code reviews. Please do not create a GitHub pull request.

  1. Commit your changes, adding a Signed-off-by line to it: git commit --signoff

  2. Write a good commit message

    • Separate subject from the body with a blank line
    • Limit the subject line to 50 characters
    • Capitalize the subject line
    • Do not end the subject line with a period
    • Use the imperative mood in the subject line
    • Wrap the body at 72 characters
    • Use the body to explain what and why vs. how

  3. Push your changes to Gerrit for code review: git push origin HEAD:refs/for/master

  4. Assign reviewers