This is a collection of tips and conventions to follow when working on the ownCloud web frontend. It is a living document, please open a PR if you find something missing.
To make sure your pull request can be efficiently reviewed and won’t need a lot of changes down the road, please run the linter and the unit tests via
yarn lint --fix and
yarn test:unit locally. Our CI will run on pull requests and report back any problems after that. For a further introduction on how we handle testing, please head to the testing docs.
In our project, we follow SemVer and keep a changelog for every change that influences the user experience (where “users” can be admins, end-users and extension developers). Some changes, like refactoring, updating dependencies or adding tests don’t require a changelog item.
Please add a changelog item to the
changelog/unreleased/ folder, referencing the issue and pull request numbers, following the changelog item template.
We’re trying to stick with early returns in our code to make it more performant and simpler to reason about it.
v-text in combination with computed properties) inside HTML tags (instead of a
<translate tag="h1"> or similar) in order to make reasoning about the DOM tree easier.
To keep the bundle size small and reduce the risk of introducing security problems for our users, we try to limit the amount of dependencies in our projects and keep them as up-to-date as possible.