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

Documentation: Added Styling Information To CONTRIBUTING.md #2474

Open
wants to merge 3 commits into
base: master
from

Conversation

@bedwardly-down
Copy link
Contributor

bedwardly-down commented Feb 8, 2020

After running into my own frustrations with styling and whatnot, I decided to add this for those that may not know where to look or how to even go about making the user interface code fit with the rest of what is already implemented.

@bedwardly-down

This comment has been minimized.

Copy link
Contributor Author

bedwardly-down commented Feb 8, 2020

It looks like the build failed because of an issue with the Travis build server and not because I made a document change.

@tessus tessus added the documentation label Feb 8, 2020
@tessus tessus changed the title Desktop: Added Styling Information To CONTRIBUTING.md Documentation: Added Styling Information To CONTRIBUTING.md Feb 8, 2020
@laurent22

This comment has been minimized.

Copy link
Owner

laurent22 commented Feb 9, 2020

Thanks, it's good to clarify this. I feel the paragraph would be more suitable for the Coding Style section though, could you move it there please?

In fact we should probably have a separate document for all coding guidelines, as Contributing.md is more a general overview.

@tessus

This comment has been minimized.

Copy link
Collaborator

tessus commented Feb 11, 2020

@bedwardly-down e.g. here's an example of how a coding guidline could look like. Some sections are missing iike Classnames, Methods, ... but I think you get the idea.

@bedwardly-down

This comment has been minimized.

Copy link
Contributor Author

bedwardly-down commented Feb 11, 2020

@bedwardly-down e.g. here's an example of how a coding guidline could look like. Some sections are missing iike Classnames, Methods, ... but I think you get the idea.

Gotya. So this is more technical based than general knowledge based.

@tessus

This comment has been minimized.

Copy link
Collaborator

tessus commented Feb 11, 2020

I'd say so. Someone who writes code already has some sort of technical understanding. Coding conventions are a technical subject.

@laurent22

This comment has been minimized.

Copy link
Owner

laurent22 commented Feb 11, 2020

For the most part our coding conventions are enforced by eslint so we don't need a very detailed document.

Off the top of my head what we should mention at least are:

  • Styling (what you've written)
  • Usage of React Hooks for new components
  • Usage of TypeScript for new file
  • Make sure that eslint is running

As it is we can already merge your Contributing.md, but for the coding guidelines I think we discuss that in the forum first.

What would be good is to find an existing example or template and work from that.

@PackElend

This comment has been minimized.

Copy link
Collaborator

PackElend commented Feb 14, 2020

I added my thought in the forum although they go beyond styling of the UI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.