Do not include js in the repository

Open
#476 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
build-system, frontend

Research direction

Inspect the repository for tracked compiled JavaScript and the build or CI configuration that produces or checks it. Remove the generated files from repository workflows where appropriate, while keeping the tutorial's JavaScript source usable; done means the repository no longer requires committed compiled JS or consistency checks for it.

Written by the indexing model from the issue text.

Description

This tutorial should be used to develop apps that will most likely not be shipped with the server. So there's no need to include the compiled js.

We should avoid including the js in the repo when possible because:

  • It leads to conflicts on rebases that would otherwise be smooth.
  • It requires rebuilding the js as a production build for every pull request.
  • It requires additional consistency checks in ci to ensure js is updated.
  • It increases the repo size significantly.
Dominant language
JavaScript
Stars
54
Forks
38
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nextcloud/app-tutorial

All issues in nextcloud/app-tutorial

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.