Azure / AppConfiguration

Questions, feedback and samples for Azure App Configuration service
MIT License
241 stars 73 forks source link

Add linting rule #938

Closed zhiyuanliang-ms closed 2 months ago

zhiyuanliang-ms commented 4 months ago

Why this PR?

Have a centralized copy of the .editorconfig file. I will also write a onenote page for it. But since our open-source client libraries also follow the linting rule set. I think here is a good place for it.

zhenlan commented 4 months ago

Who is the audience for these files? How are these files going to be used?

zhiyuanliang-ms commented 4 months ago

Who is the audience for these files? How are these files going to be used?

App Config team and anyone wants to contribute to our open-source client libraries would be the audience.

I think we should have a centralized copy of the linting rule set (.editorconfig file) to be referenced and ensure every repo will use the same rule set. I do create an onenote page for it. But we also have feature management and .net provider which are on github. So I think this public repo is a better place to keep the linting rule set.

juniwang commented 4 months ago

Keeping a centralized copy as single source of truth would be a good idea. At the same time, it also brings in some sort of cross repo dependencies making it less convenient in setting up CI/CD(especially on ADO) and local env.

rossgrambo commented 4 months ago

I like to think this is the .editorconfig for our team that we agreed on. Each repo might have slight variations (if there's reason to)- but this is the team's / would be used for a new repo.

Although I don't think I personally prefer for it to be public. It's not necessarily bad- but I don't see clear value.

rossgrambo commented 4 months ago

If we believe all .editorconfig files for our repos need to be tightly coupled / the same- I don't see value in having a copy here. I don't believe that's the case.

zhenlan commented 4 months ago

I'm with @rossgrambo on this. This repo is for customers, not centralized storage for our team. External developers who may contribute to our components will follow/obey the linting rules of respective repos.

zhiyuanliang-ms commented 4 months ago

@zhenlan

This repo is for customers

I agree with this. Then I will move the rule set copy to our onenote.