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

[Proposal] Remove CONTRIBUTORS.md or move it to its own repo. #28331

Open
ungaro opened this issue Aug 27, 2024 · 0 comments
Open

[Proposal] Remove CONTRIBUTORS.md or move it to its own repo. #28331

ungaro opened this issue Aug 27, 2024 · 0 comments
Labels
proposal A proposal for something new.

Comments

@ungaro
Copy link
Contributor

ungaro commented Aug 27, 2024

💥 Proposal

Over time, the CONTRIBUTORS.md file has grown significantly, now reaching 4.1 MB. This is a substantial size, especially considering that anyone who clones the Leo repository also downloads this file, which doesn’t contribute to the functionality of the compiler itself. Given that this file currently accounts for approximately 18% of the entire repository, I would like to propose two possible solutions:

  • Remove the file altogether, or
  • Create a separate leo-contributors repository and move the CONTRIBUTORS.md file there.

I understand that this proposal might be sensitive, as it involves recognizing the contributions of many individuals. My intention is not to diminish anyone’s contributions but to optimize the repository for efficiency.

Thank you for considering this proposal with an open mind.

Additionally: There have been numerous issues related to the All-Contributors bot not recognizing usernames that contain dashes. Many of these issues are duplicates and stem from the fact that usernames must be preceded by the @ sign for the bot to recognize them correctly. The All-Contributors bot can handle usernames with dashes, or even multiple dashes, as long as the @ sign is included before the username. For more details, see: GitHub Issue #292.

File Size
Total size excluding .git: 23M
./tests/tests/compiler/additional_benches/big.leo 4.1M
./CONTRIBUTORS.md 4.1M
./examples/battleship/diagram.png 160K
./tests/tests/compiler/additional_benches/massive.leo 116K
./Cargo.lock 116K
./tests/expectations/execution/primitive_casts.out 92K
./compiler/passes/src/type_checking/checker.rs 68K
./compiler/passes/src/type_checking/check_expressions.rs 56K
./compiler/ast/src/functions/core_function.rs 52K
./examples/twoadicity/build/main.aleo 48K
./examples/hackers-delight/ntzseals/build/main.aleo 44K
./examples/hackers-delight/ntzreisers/build/main.aleo 40K
./examples/battleship/README.md 40K
./compiler/parser/src/parser/expression.rs 40K
./tests/expectations/execution/flattened_function_and_inline_matches.out 36K
./leo/package/LICENSE.md 36K
./errors/LICENSE.md 36K
./compiler/span/LICENSE.md 36K
./compiler/passes/LICENSE.md 36K
./compiler/parser/LICENSE.md 36K
... ...
@ungaro ungaro added the proposal A proposal for something new. label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal A proposal for something new.
Projects
None yet
Development

No branches or pull requests

1 participant