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

[idea] Recommend adding linting as part of OEP process #522

Closed
robrap opened this issue Sep 15, 2023 · 2 comments
Closed

[idea] Recommend adding linting as part of OEP process #522

robrap opened this issue Sep 15, 2023 · 2 comments

Comments

@robrap
Copy link
Contributor

robrap commented Sep 15, 2023

We've found that some OEPs like OEP-9 are proposed and agreed upon, but without anything enforcing the decision, it can sit and be ignored. Note that linting + lint-amnesty could be used to ensure that problems don't grow, even if we don't refactor everything to match some new decision.

The idea here would be to update OEP-1 and educate engineers to consider introducing linting where possible to help enforce decisions. It could provide examples or links to how-tos, etc.

@sarina
Copy link
Contributor

sarina commented May 17, 2024

We are moving towards a model of maintainership of OEPs where we no longer merged if they are not agreed upon with the community as Provisional or Accepted. We are currently working to draw down the OEP issues and move OEPs to Obsolete in the coming weeks so the OEP documents are a source of truth, not a confusing mixture of "what's this?". We are going to be much more active maintainers on this repo to enforce that.

I don't think adding linting is the right solution in most cases, as OEPs should mostly describe process (like Core Contributors) or architectural changes (eg event bus, a move to TypeScript) that don't lend themselves to linting. Perhaps more targeted ADRs would be the level at which linting a particular change could be effected.

If you feel strongly against this, please reopen with some examples of where linting could have been built, how it would have helped, and describe the amount of help versus amount of effort that caused.

@sarina sarina closed this as completed May 17, 2024
@robrap
Copy link
Contributor Author

robrap commented May 17, 2024

All good. Thanks. I do wish we have more linting to backup our decisions, but if this moved forward, we'd need a linter to catch missing linters. ;) Thanks for cleaning up these old PRs.

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