search

Epitech / coding-style-checker

25 stars 43 forks source link

Open Source the Coding Style Checker #19

Open clement-antoine-xavier opened 6 months ago

clement-antoine-xavier commented 6 months ago

To enhance collaboration and continuous improvement, I propose making the coding style checker open source. This would allow both the community and students to contribute through pull requests, leading to a better codebase for everyone involved.

Opening up the style guide will foster a collaborative environment where users can suggest improvements, report inconsistencies, and keep the checker up-to-date.

Sigmanificient commented 6 months ago

The coding style script itself is already public, only the ruleset is internal and accessible to the students. You may want to take a look at the following issue in Banana vara coding style checker:

I do agree that opening the repository to the public would be nice, to facilitate integration with existing student tools, such as Abricot-Norminette or ECSLS.

However I don't think it would help collaboration on the coding style, unfortunately. In the current state, banana accept pull requests but the review process is tedious as the APE in charge of the project as a ton of other work to process. As a manner of fact, I have opened many pull requests over the time, and some are waiting review for over a couple of month, despite fixing important bugs.

I have also mentioned the lack project normalization with standard python tooling and proposed core changes to the architecture to make the code more to readable and maintainable. To make contribution easier, we need another maintainer to work actively on the repository.

Bqleine commented 6 months ago

The most important is for the code to be released under an open source license. Then students can do awesome stuff without needing pull requests or any intervention from EPITECH. And that would require your approval @Sigmanificient since you have non-trivial contributions to the coding style already merged.

I would greatly appreciate if you could do some lobbying from Paris, as response from the APE on my issue has been nonexistent, and just this is frankly disappointing.

Sigmanificient commented 6 months ago

Unfortunately, I am a simple student too. I requested many times for the coding style to get some attention. So far my attempts have led to nothing