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

Guiding newcomers #12

Open
rodolfo-viana opened this issue Oct 18, 2018 · 2 comments
Open

Guiding newcomers #12

rodolfo-viana opened this issue Oct 18, 2018 · 2 comments
Labels
repo organization Suggestions on how to make this repo neat

Comments

@rodolfo-viana
Copy link

We must consider this repo will receive newcomers from different background. Some with experience on Git and GitHub; some who has never opened Terminal/Command Prompt.

Considering this, I thought it would be nice to have a guide divided into chapters instead of a simple README.md -- chapters teaching how to install and use Git and GitHub, serenata_toolbox, Jupyter etc. And README.md would be the index.

I could provide this.

What do you guys think?

@rodolfo-viana rodolfo-viana added the repo organization Suggestions on how to make this repo neat label Oct 18, 2018
@cuducos
Copy link
Collaborator

cuducos commented Oct 18, 2018

IMHO we might ending up teaching so much that might be already covered by other sources. Usually I tend to restrict the repo documentation to what belongs to the repo and link other sources when helpful for beginners. In spite of that I'm not against a Git guide or anything like that — I'm just sharing my rational to prioritize what I should spend time on creating and maintaining ; )

@rodolfo-viana
Copy link
Author

For general repos I would agree with you, @cuducos. But considering the educational purpose of this one, I think it would be helpful. I myself based this suggestion on doubts I used to have when I was in the beginning, learning basic stuff. I could find answers elsewhere from the repo itself but it would have saved me a lot of time it I had had this in one place.

Don't you agree?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
repo organization Suggestions on how to make this repo neat
Projects
None yet
Development

No branches or pull requests

2 participants