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

Design decisions for the tutorials (Please read this before suggesting changes) #1

Open
fineanmol opened this issue Sep 26, 2022 · 5 comments
Labels
hacktoberfest-accepted hacktoberfest-accepted

Comments

@fineanmol
Copy link
Owner

This is not an issue, but more of a documentation of the design choices we made for the tutorials and what we learned from community feedback.

1. Keep the tutorial short

I think this is one of the most important aspects that helped this project grow. Getting a pay-off within five minutes of learning something is remarkable. For brevity, we have to compromise on details. A lot of details are missing from the main tutorial. From explanations on what actually happens when you run those commands to other good practices one could follow.

#2. Accessibility matters

We want these tutorials to be accessible to as much people as possible. Be it somebody having trouble with language barriers or someone with limited internet speed. Translations help people understand this in languages they're more comfortable with. Keeping the size of this repository small will help with limited bandwidth.

3. Contributors.md doesn't matter

This is one point where I had multiple discussions with the community. Contributors list exists just as a file you can edit to work through the tutorial. How it looks or what you add there doesn't matter. We'll remove most entries in it from time to time because we don't want someone being left out because their text editor can't open a huge file.

4. Be generic.

We could make assumptions about what OS most of our users are using or what terminal emulator or text editor they're comfortable with. By not making such assumptions, we give our readers more freedom and include more people.

Feel free to challenge any of the above in the comments. I'd love to get feedback from you. Let's have a discussion.
Also, there are things I'm struggling to design. Like how to give directions to proceed right after one finishes the tutorial. So, comment down below what you're looking for right after you finish the tutorial and what you're missing.

fineanmol pushed a commit that referenced this issue Oct 1, 2022
fineanmol pushed a commit that referenced this issue Oct 1, 2022
Merge pull request #106 from fineanmolwork/master
fineanmol added a commit that referenced this issue Oct 1, 2022
Merge pull request #1 from fineanmol/master
fineanmol pushed a commit that referenced this issue Oct 1, 2022
wrote git commands which can help a beginner to make his/her first pull request
fineanmol pushed a commit that referenced this issue Oct 1, 2022
fineanmol pushed a commit that referenced this issue Oct 1, 2022
fineanmol pushed a commit that referenced this issue Oct 3, 2022
fineanmol added a commit that referenced this issue Oct 3, 2022
Merge pull request #1 from fineanmol/master
fineanmol pushed a commit that referenced this issue Oct 3, 2022
@fineanmol fineanmol added the hacktoberfest-accepted hacktoberfest-accepted label Oct 3, 2022
fineanmol pushed a commit that referenced this issue Oct 5, 2022
Created profile Piyush_Arora.md in profiles directory
fineanmol pushed a commit that referenced this issue Oct 5, 2022
Create helloworldscript.bye818.html
fineanmol pushed a commit that referenced this issue Oct 8, 2022
Added hello_world_kbhavre.py to script folder
fineanmol pushed a commit that referenced this issue Oct 8, 2022
…script

Create Hello_World_Deniernal354.js
fineanmol pushed a commit that referenced this issue Oct 8, 2022
fineanmol pushed a commit that referenced this issue Oct 8, 2022
fineanmol pushed a commit that referenced this issue Oct 9, 2022
fineanmol pushed a commit that referenced this issue Oct 12, 2022
@pushpanjali-10
Copy link

I would like to make contribution in this repository.

fineanmol pushed a commit that referenced this issue Oct 17, 2022
fineanmol pushed a commit that referenced this issue Oct 17, 2022
fineanmol pushed a commit that referenced this issue Oct 18, 2022
fineanmol pushed a commit that referenced this issue Oct 18, 2022
fineanmol pushed a commit that referenced this issue Oct 18, 2022
@Arunima007
Copy link

I would like to contribute . Please assign this to me.

@prabhleenn
Copy link

please assign me this

@Ashima2003
Copy link

Heyy I want to work on this issue. Please assign it to me.

@saku1331
Copy link

saku1331 commented Oct 4, 2023

I wish to contribute. Kindly assign this to me.

Tealspider23 added a commit to Tealspider23/hacktoberfest that referenced this issue Oct 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted hacktoberfest-accepted
Projects
None yet
Development

No branches or pull requests

6 participants