Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Finalize open-sourcing front end #78

Open
abettermap opened this issue Jun 4, 2020 · 1 comment
Open

Finalize open-sourcing front end #78

abettermap opened this issue Jun 4, 2020 · 1 comment
Labels
effort: 4 (high) Much work required, may need to break out focus: documentation Documentation tasks such as Markdown, inline code comments, wiki, etc. priority: 3 (med) Should be completed after high-priority relates: org repos Requires changes to or from other repos within this GH org.
Milestone
Finalize front-en...

Comments

@abettermap
Copy link
Contributor

Description

Catch-all from Jira on suggestions we should do to wrap up open-sourcing the front end. Needs to be broken out into separate issues...

Related items

Jira CSR-124 (epic): Make Frontend Open Source

...to get the ball rolling on outside help and to get some recognition.

Jira CSR-170: Establish front-end code consistency

Pretty much already there with everything except markdown in the front-end repo. MD is only a small part of the codebase, but since all the other languages are formatted then might as well follow suit with MD. Makes for less conflict potential and cleaner diffs and readability.

Jira CSR-171: Markdown: try Prettier first

...since already connected to eslint. See this.

Jira CSR-172: Markdown: if prettier no-go...

...use other VS Code extensions:

  • Markdown all-in-one
  • Markdown lint

Jira CSR-173: eslint: integrate Jason's config

Tried this before but it didn’t seem to have an impact. Here are the main things:

  • Warn about console and debugger
  • Error when variable is not used
  • Improve block spacing/padding

Jason has config for these. Main rule is 80-char column limit.

Jira CSR-175: Document required tool/s

Doesn’t have to be VS Code, but users do need eslint, editorconfig, prettier extensions.

Also instruct how to enable “Format on save” in vs code.

Resolution

Break out into 2-3 separate issues, use "Finalize front-end..." milestone.
@abettermap abettermap added the status: unreviewed A maintainer needs to look into this label Jun 4, 2020
@abettermap abettermap added effort: 4 (high) Much work required, may need to break out focus: documentation Documentation tasks such as Markdown, inline code comments, wiki, etc. priority: 3 (med) Should be completed after high-priority relates: org repos Requires changes to or from other repos within this GH org. and removed status: unreviewed A maintainer needs to look into this labels Jun 4, 2020
@abettermap
Copy link
Contributor Author

...ideally use all these at the GH org. level where relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort: 4 (high) Much work required, may need to break out focus: documentation Documentation tasks such as Markdown, inline code comments, wiki, etc. priority: 3 (med) Should be completed after high-priority relates: org repos Requires changes to or from other repos within this GH org.
Projects
None yet
Milestone
Finalize front-end open sourcing
Development

No branches or pull requests
1 participant
@abettermap