docs: update HACKING.md with current descriptions #5507
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- remove old setup instructions with dotenv - add setup instructions for yarn/vite - add test running instruction - move site speed test running to fitting section - link to maas-dev-setup repo instead of manual instructions how to setup a dev env This file needs more updating but this update should already help new users to set up and running more quickly.
Demo
Jenkins 
demos.haus 
ndv99
reviewed
Jul 23, 2024
docs/HACKING.md
Outdated
| - [Integration tests](#integration-tests) | ||
| - [Unit tests](#unit-tests) | ||
| - [Performance tests](#performance-tests) | ||
| - [Project conventions](#project-conventions){#toc-project-conventions} |
There was a problem hiding this comment.
Why do all of these headings have {#toc-something} afterwards? I don't think this is normal syntax, and it shows up in the file preview:
ndv99
requested changes
Jul 23, 2024
docs/HACKING.md
Outdated
|
|
||
| You can run MAAS-UI on your local machine assuming that you already have an instance of MAAS running somewhere that you can connect to. | ||
|
|
||
| In the following sections we assume that you're having your MAAS back-end running on `http:/10.10.0.30:5240`. This can easily be adapted to other IPs, names, or `https`. |
There was a problem hiding this comment.
double / after "http"
Suggested change
| In the following sections we assume that you're having your MAAS back-end running on `http:/10.10.0.30:5240`. This can easily be adapted to other IPs, names, or `https`. | |
| In the following sections we assume that you're having your MAAS back-end running on `http://10.10.0.30:5240`. This can easily be adapted to other IPs, names, or `https`. |
docs/HACKING.md
Outdated
|
|
||
| #### Integration tests | ||
|
|
||
| - To run cypress end to end test run `yarn cypress-open` |
There was a problem hiding this comment.
Suggested change
| - To run cypress end to end test run `yarn cypress-open` | |
| - To run Cypress end-to-end tests run `yarn cypress-open` |
docs/HACKING.md
Outdated
| Now you are ready to create a PR from GitHub by browsing to the branch that you just set up. | ||
|
|
||
| *Important tips*: | ||
| - We use conventional commits and conventional PRs and the format will be enforced by our CI. To make your life easy, you should commit using them right from the start |
There was a problem hiding this comment.
Suggested change
| - We use conventional commits and conventional PRs and the format will be enforced by our CI. To make your life easy, you should commit using them right from the start | |
| - We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and conventional PRs and the format will be enforced by our CI. To make your life easy, you should commit using them right from the start. You can see a list of valid scopes [here](https://github.com/canonical/maas-ui/blob/main/.github/workflows/pr-lint.yml#L19-L37) |
There was a problem hiding this comment.
Thanks for the links!
docs/HACKING.md
Outdated
|
|
||
| ```shell | ||
| multipass shell snap-maas | ||
| ``` | ||
|
|
||
| #### LXD | ||
| ### LXD | ||
|
|
||
| ```shell | ||
| lxc exec snap-maas bash -- su ubuntu |
There was a problem hiding this comment.
This command doesn't need bash to be called explicitly, you can just do lxc exec snap-maas -- su ubuntu
addresses @ndv99's comments
ndv99
added
Review: Code +1
Review: QA +1
and removed
Review: Code needed
Review: QA needed
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Done
QA steps
# Development setupand see if you can use them to setup a MAAS UIHACKING.mdhere in githubScreenshots
Not needed, see the file here: https://github.com/tmerten/maas-ui/blob/71fe0627eedf9e4bd5cfc79388c6e7fc296e2efe/docs/HACKING.md#set-up-a-development-container
Notes
This file needs more updating but this update should already help new users to set up and running more quickly.