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

Update and reformat FILE_STRUCTURE.md to include explanations of new files #121

Closed
Milind220 opened this issue Apr 22, 2022 · 0 comments
Closed
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Milind220
Copy link
Collaborator

FILE_STRUCTURE.md is supposed to explain to new contributors the overall structure of Ozone. This is so that they feel more comfortable moving from file to file to make their contributions.

Currently, it's been a little while since FILE_STRUCTURE was updated. I'm also not too impressed with the current organisation of the file.

Here's the Issue:

  • Add description of historical directory and the files within
  • Add description of ci/cd directory
  • Reformat the file to make it clearer to read

Please ask away if you're not sure what of the purpose of any file! We're more than happy to help you contribute :)

@Milind220 Milind220 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant