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.

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

Define Style coding convention #396

Open
josix opened this issue Apr 8, 2023 · 0 comments
Open

Define Style coding convention #396

josix opened this issue Apr 8, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@josix
Copy link
Collaborator

josix commented Apr 8, 2023

As discussed in the meeting, we would like to have a rule of coding convention about writing styles.
Please help create a document about the practice of writing CSS style attached with the created PRs as an example for reference.
I think the below points need to be emphasized, please feel free to add it if there are other concerns.

  • Writing inline style as first option, and write class alternatively if the style is not supported by tailwindcss.
  • If there exists duplicated css style in the common HTML structure, please consider extracting it as another component with unified style definitions.
  • The content in i18n should be limited to items that require translation. Unrelated content such as external links, icons should be avoided. PR#395 is an example of this.
  • Comments should only be added to code that contains useful information for programming. Avoid adding comments to code that is uncertain or about to be deleted.
  • The code files related to the schedule page are good examples that follow the above points.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🔖 Ready
Development

No branches or pull requests

2 participants