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

EVM Engineering: move top-level markdown files into meta/docs folder #12670

Closed
smartcontracts opened this issue Oct 27, 2024 · 5 comments
Closed
Assignees
Labels
C-discussion Category: A long-form discussion

Comments

@smartcontracts
Copy link
Contributor

I'd like to propose that top-level markdown files like VERSIONING.md and CONTRIBUTING.md go into a docs or meta folder or something like that. No real opinion on what the folder is called. All of those files clog up the top-level folder and we can easily just link to them in the README.

Thoughts?

@smartcontracts smartcontracts added the C-discussion Category: A long-form discussion label Oct 27, 2024
@ControlCplusControlV
Copy link
Contributor

This is worth it imo, I would vote for the folder /meta, do you know if README needs to stay top level for github though?

@smartcontracts
Copy link
Contributor Author

Yeah README needs to be top-level

@ControlCplusControlV
Copy link
Contributor

Actually, since these files clutter both ./ and ./packages/contracts-bedrock should we move these top level files to /meta and /meta/contracts-bedrock or /meta and /packages/contracts-bedrock/meta ?

@smartcontracts
Copy link
Contributor Author

I'd prefer contracts-bedrock/meta for now

@ControlCplusControlV
Copy link
Contributor

Fixed in #12727

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-discussion Category: A long-form discussion
Projects
None yet
Development

No branches or pull requests

2 participants