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

Document all the places where packages are listed or filtered #14508

Closed
4 tasks
gziolo opened this issue Mar 19, 2019 · 1 comment
Closed
4 tasks

Document all the places where packages are listed or filtered #14508

gziolo opened this issue Mar 19, 2019 · 1 comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts [Type] Code Quality Issues or PRs that relate to code quality [Type] Developer Documentation Documentation for developers

Comments

@gziolo
Copy link
Member

gziolo commented Mar 19, 2019

This issue was discussed several times in the past few weeks. It was raised again by @aduth yesterday in this comment:

I'm wondering if we ought to start codifying / documenting where we have these conventions, i.e. "sources should have a src/index.js file".

There are a few places where we execute some logic based on the list of packages which is either hardcoded or manually crafted, some examples:

We should at least document all those places to ensure we update all of them when necessary. Ideally, we abstract away as much as possible and start using helper methods which makes maintenance easier.

@gziolo gziolo added [Type] Developer Documentation Documentation for developers [Type] Code Quality Issues or PRs that relate to code quality labels Mar 19, 2019
@gziolo gziolo added the Good First Issue An issue that's suitable for someone looking to contribute for the first time label Mar 19, 2019
@gziolo gziolo added the Needs Dev Ready for, and needs developer efforts label Apr 10, 2019
@gziolo
Copy link
Member Author

gziolo commented Dec 27, 2020

It's automated as of today - those list are generated with pattern matching.

@gziolo gziolo closed this as completed Dec 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts [Type] Code Quality Issues or PRs that relate to code quality [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

1 participant