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

add .editorconfig #1547

Open
rursprung opened this issue Dec 23, 2021 · 3 comments
Open

add .editorconfig #1547

rursprung opened this issue Dec 23, 2021 · 3 comments
Labels
enhancement New feature or request good first issue These are recommended starting points for newcomers looking to make their first contributions. triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable.

Comments

@rursprung
Copy link
Contributor

Is your feature request related to a problem? Please describe.
due to the lack of an .editorconfig PRs are not properly aligned in terms of formatting, etc.

Describe the solution you'd like
add a .editorconfig with generally agreed upon defaults. note that the main OpenSearch repo contains a .editorconfig which would be a good starting point.

Describe alternatives you've considered
using .editorconfig is the de-facto standard.

Additional context
i didn't check the status of the other OpenSearch repos. if it's missing in them as well this might be well suited for a meta-issue which is then applied to all of them (so that all have the same .editorconfig.

side-note: adding a .gitattributes in the same step might be a good idea. again, this file is present in the main OpenSearch repo but missing here.

@rursprung rursprung added the enhancement New feature or request label Dec 23, 2021
@davidlago davidlago added the triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable. label Oct 10, 2022
@davidlago
Copy link

Sorry for the late reply. We use checkstyle for linting, and we've documented how to run locally prior to submitting PRs here

@rursprung
Copy link
Contributor Author

@davidlago: one tool doesn't exclude the other: checkstyle is used to check the style, editorconfig is used to configure the editor. the latter allows formatting the code automatically in the correct way expected by the former. the two tools are complimentary. please re-consider (not just for the security plugin, in general for all OpenSearch repos).

@davidlago
Copy link

Gotcha... let me re-open, perhaps we should move this to the org level as a broader question/recommendation that perhaps we can make there.

@davidlago davidlago reopened this Aug 31, 2023
@github-actions github-actions bot added the untriaged Require the attention of the repository maintainers and may need to be prioritized label Aug 31, 2023
@davidlago davidlago removed the untriaged Require the attention of the repository maintainers and may need to be prioritized label Aug 31, 2023
@peternied peternied added the good first issue These are recommended starting points for newcomers looking to make their first contributions. label Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue These are recommended starting points for newcomers looking to make their first contributions. triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable.
Projects
None yet
Development

No branches or pull requests

3 participants