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

Linter for basic project structure #163

Open
cornelius opened this issue Oct 23, 2024 · 3 comments
Open

Linter for basic project structure #163

cornelius opened this issue Oct 23, 2024 · 3 comments
Assignees

Comments

@cornelius
Copy link
Member

We require certain files such as README, LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, MAINTAINER, GOVERNANCE, etc. We could set up a linter which checks this structure and maybe also for some necessary content. This linter could be run as part of the onboarding process.

@mxmehl
Copy link
Member

mxmehl commented Dec 10, 2024

@cornelius, could that be based on our internal Open Source Linter? In some way, it has more features than OpenRail would require, on the other hand our linter doesn't check all of these files (but could be quite easily extended to do it).

@cornelius
Copy link
Member Author

That's a good idea. We could check it by running the linter on the OpenRail projects and see how useful it currently is and what is missing. If we find it useful we can discuss open sourcing the linter.

@mxmehl mxmehl self-assigned this Jan 7, 2025
@mxmehl
Copy link
Member

mxmehl commented Jan 7, 2025

OK, I will pick this up in the following weeks.

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