PhilanthropyDataCommons / auth

PDC related extensions that were made for the keycloak auth service
1 stars 1 forks source link

Add an editorconfig file #23

Closed slifty closed 1 year ago

slifty commented 1 year ago

This PR documents intended default whitespace rules in a format that most editors understand.

slifty commented 1 year ago

FWIW we can also update the whitespace to whatever a person writing java would expect! it would just be great to have an editorconfig for whatever that style is.

(just to give a use case: I have my local editor's configuration to default to tabs instead of spaces unless a local project overrides, so even if we wanted to keep typical Java whitespace it'd be great to document for the reasons you mentioned)

I already pressed the merge button but just wanted to underscore that IMHO it's totally ok to have different whitespace rules for different types of file -- we could add a [*.java] that has different defaults for those in future.

bickelj commented 1 year ago

@slifty I agree with the possibility, but I see a large company that uses 2-space indent style for Java as well. Consistency across PDC is good. So we should aim for 2-spaces here as well as other projects, I think.