openbmc/webui-vue/CONTRIBUTING.md

1 # Contributing to WebUI-Vue
9 - [Project Setup](#project-setup)
10 - [Asking Questions](#asking-questions)
11 - [Submitting Bugs](#submitting-bugs)
12 - [User Research](#user-research)
13 - [Design Reviews](#design-reviews)
14 - [Help Wanted](#help-wanted)
15 - [Code Reviews](#code-reviews)
22 …up/Integration guidelines](https://github.com/openbmc/docs/blob/master/development/gerrit-setup.md)
29 [Code Reviews section](#code-reviews) below.
31 1. Visit <https://gerrit.openbmc-project.xyz/admin/repos/openbmc/webui-vue>
32 2. Clone the repo using the `Clone with commit-msg hook` link
33    - Windows users may need to separate the two commands depending on if they
46    - .env.development.local
48    - `BASE_URL="https://<BMC IP address or FQDN>"`
50 ### Compile and hot-reload for development
75 [OpenBMC Code of Conduct](https://github.com/openbmc/docs/blob/master/code-of-conduct.md).
83 - Mail: <openbmc@lists.ozlabs.org> <https://lists.ozlabs.org/listinfo/openbmc>
84 - Discord: <https://discord.gg/69Km47zH98>
89 [existing GitHub issues](https://github.com/openbmc/webui-vue/issues) to see if
91 [Bug report template](https://github.com/openbmc/webui-vue/issues/new?assignees=&labels=&template=b…
95 [existing GitHub issues](https://github.com/openbmc/webui-vue/issues). If no one
97 [Feature request template](https://github.com/openbmc/webui-vue/issues/new?assignees=&labels=&templ…
102 To improve the OpenBMC Web UI, we are actively seeking end-user feedback through
108 OpenBMC GUI. The time commitment is minimal: 1-hour feedback sessions conducted
122 [OpenBMC GUI Design Workgroup](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group).
128 [Help Wanted Project](https://github.com/openbmc/webui-vue/projects/2). If you
138 1. Commit your changes, adding a Signed-off-by line to it:
139    `git commit --signoff`
140 1. Write a [good commit message](https://chris.beams.io/posts/git-commit/)
141    - Separate subject from the body with a blank line
142    - Limit the subject line to 50 characters
143    - Capitalize the subject line
144    - Do not end the subject line with a period
145    - Use the imperative mood in the subject line
146    - Wrap the body at 72 characters
147    - Use the body to explain what and why vs. how