Skip to content

Commit

Permalink
chore(docs): restructure Development setup - Contributing section
Browse files Browse the repository at this point in the history
Signed-off-by: Grigorii K. Shartsev <[email protected]>
  • Loading branch information
ShGKme committed Feb 3, 2025
1 parent 3e03ce7 commit cef3fdd
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ import { NextcloudVuePlugin } from '@nextcloud/vue'
Vue.use(NextcloudVuePlugin)
```

## πŸ§‘β€πŸ’» Development setup
## 🀝 Contributing

### πŸ§‘β€πŸ’» Development setup

If you want to work on improving the components it’s best to run the latest code and link it to your local Nextcloud installation:

Expand All @@ -77,7 +79,7 @@ If you want to work on improving the components it’s best to run the latest co
- In the repository of an app do `npm link @nextcloud/vue` (you need to re-link any time you do `npm ci` in the app)
4. Then build the app with: `npm run build` (or watch for changes with `npm run watch`)

## 🌐 Translations
### 🌐 Translations

Use `t` and `n` functions from `src/l10n.js` to display translated strings. They follow `gettext` and `ngettext` interface from [`@nextcloud/l10n/gettext`](https://nextcloud-libraries.github.io/nextcloud-l10n/modules/_nextcloud_l10n_gettext.html).

Expand All @@ -100,13 +102,13 @@ Our awesome translation community will then be notified and a bot will sync tran
npm run l10n:extract
```

## 🐸 Styleguide
### 🐸 Styleguidist

When developing new components or extending components, make sure to also have some bits of related documentation like examples, where applicable.
To test components and the documentation in that context, you can run `npm run styleguide` to run a local server that serves the style guide
with all the components.

### Using vue-devtools in Firefox
#### Using vue-devtools in Firefox

If you want to use [vue-devtools](https://github.com/vuejs/vue-devtools) in Firefox, you need to:

Expand Down

0 comments on commit cef3fdd

Please sign in to comment.