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

What could be a decent structure to begin with? #1

Open
13point5 opened this issue Sep 10, 2022 · 1 comment
Open

What could be a decent structure to begin with? #1

13point5 opened this issue Sep 10, 2022 · 1 comment

Comments

@13point5
Copy link
Collaborator

Let's lay down some guidelines for contributing to this repo and the repo structure to ensure this works well.

@13point5
Copy link
Collaborator Author

I believe that our goal, for now, should ideally be to test the possibility of getting mentees to collaborate with others at MWB with very little technical investment. Once we know that this is a possible and valuable activity, then we can improve the system to allow it to scale and make this a voluntary action taken by the mentees themselves.

We could have a structure as simple as this:

repo/
├─ README.md
├─ CONTRIBUTING.md
├─ LICENSE.md
├─ projects/
│  ├─ Random Project/
│  │  ├─ README.md
│  │  ├─ Sample Project Demo.mp4

In the CONTRIBUTING.md file, we can mention guidelines for suggesting new projects and changes to existing ones.

What do you all think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant