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

Coding Style Guidelines #4

Open
rraks opened this issue Apr 9, 2020 · 1 comment
Open

Coding Style Guidelines #4

rraks opened this issue Apr 9, 2020 · 1 comment

Comments

@rraks
Copy link

rraks commented Apr 9, 2020

We need to have a standard set of guidelines regarding coding style.
For e.g, https://google.github.io/styleguide/javaguide.html
It need not be a publicly accepted one too, but we need to put the styles we follow somewhere.
Problems if we don't -

  1. Git will unnecessarily diff changes in indentations if auto-formatting/opening file in an editor which auto-formats
  2. Non-uniform readability
  3. Doc-generation from code - I don't know if there are javadocs for current codebase, but these tools require a standard code style.
@pct960
Copy link
Member

pct960 commented Apr 9, 2020

Sure, we can use something like Google's java formatter to automatically reformat the code to comply with Google's java code style.

Feel free to add these things to the doc and create a PR.

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

No branches or pull requests

2 participants