Skip to content

Commit 81f8c9f

Browse files
shreyamalogishreyamalogi
authored
guide to get started
0 parents  commit 81f8c9f

11 files changed

+189
-0
lines changed

‎README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Welcome!
2+
3+
![](cm-banner.png)
4+
5+
The CodeMacrocosm's guide is a customized program which offers students an opportunity to learn programming under the guidance of great mentors. Students get to learn the git workflow, explore new languages, frameworks & tools, improve leadership and collaboration skills while following best coding and open-source practices. This would help them build a strong foundation for their early career and they would walk away with an amazing experience.
6+
7+

‎SUMMARY.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Table of contents
2+
3+
* [Welcome!](README.md)
4+
5+
6+
## Responsibilities
7+
8+
* [Students](responsibilities/students.md)
9+
* [Mentors](responsibilities/mentors.md)
10+
* [Junior Mentors](responsibilities/junior-mentors.md)
11+
12+
---
13+
14+
* [FAQ](faq.md)
15+
* [Learning path](learningpath.md)
16+
* [contests](contest.md)
17+
* [Code of Conduct](code-of-conduct.md)
18+
* [Contact Us](communication.md)
19+

‎cm-banner.png.jpeg

104 KB
Loading

‎code-of-conduct.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Code of Conduct
2+
3+
### Our Pledge <a id="our-pledge"></a>
4+
5+
We as contributors, mentors and managers pledge to make participation in this program a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy program.
8+
9+
### Our Standards <a id="our-standards"></a>
10+
11+
Examples of behavior that contributes to a positive environment for our program include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall program
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others’ private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
### Enforcement Responsibilities <a id="enforcement-responsibilities"></a>
28+
29+
Program managers and mentors are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Program managers and mentors have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
### Scope <a id="scope"></a>
34+
35+
This Code of Conduct applies within all program spaces, and also applies when an individual is officially representing the program in public spaces. Examples of representing our program include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
### Enforcement <a id="enforcement"></a>
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the program managers responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All program managers and mentors are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
### Enforcement Guidelines <a id="enforcement-guidelines"></a>
44+
45+
Program managers and mentors will follow these Program Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
#### 1. Correction <a id="1-correction"></a>
48+
49+
**Program Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the program.
50+
51+
**Consequence**: A private, written warning from program managers and mentors, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
#### 2. Warning <a id="2-warning"></a>
54+
55+
**Program Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in program spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
#### 3. Temporary Ban <a id="3-temporary-ban"></a>
60+
61+
**Program Impact**: A serious violation of program standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the program for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
#### 4. Permanent Ban <a id="4-permanent-ban"></a>
66+
67+
**Program Impact**: Demonstrating a pattern of violation of program standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the program.
70+
71+
### Attribution <a id="attribution"></a>
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
74+
75+
Program Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
76+

‎communication.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Contact Us
2+
3+
Before contacting us, please check the Program Overview and Communication sections corresponding to your cohort which will answer most of the questions.
4+
5+
If you have questions please email:
6+
[Shreya Malogi, Founder Codemacrocosm](mailto:[email protected])
7+

‎contests.md.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
contest details

‎faq.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# FAQ
2+
3+
* **Can a student or mentor from any college participate?** Yes, anyone who likes open source software is welcome!
4+
* **Can a student without any programming experience participate?** Yes, we think is enough time for a beginner with basic familiarity with computers to learn the basics of a programming language.
5+
* **Is there an entry fee or selection criteria?** No.
6+
* **Is programming background necessary to start learning Git?** No, Git is a version control system that can be used to record changes to even a .txt file
7+
* **What’s the difference between Git & GitHub?** Git is a version control system that lets you manage and keep track of your source code history whereas GitHub is a cloud-based hosting service that lets you manage Git repositories \(and much more\).
8+
* **Would you teach programming to beginners?** Unforunately no. We won't be able to teach you programming but we’ll guide and help you with coding the right way, suggest resources and inculcate best practices!
9+

‎learningpath.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Resources
2+
3+
## Git and GitHub
4+
5+
Below are a few suggested resources which would help you to get familiar with Git and GitHub. You don't need to complete all of them, but familiarity and some practice with common commands would be helpful.
6+
7+
* [Git tutorial for beginners](https://www.youtube.com/watch?v=PWqS4NBhEY8)
8+
* [GitHub flow](https://guides.github.com/introduction/flow/)
9+
* [GitHub Learning Lab](https://lab.github.com/)
10+
* [GitHub workflow live demo](https://www.youtube.com/watch?v=Z1G_pR3TooQ)
11+
* [Hello-opensource \(practice commands](https://github.com/FOSS-Cell-GECPKD/Hello-opensource)\)
12+
* [Udacity course on Git](https://www.udacity.com/course/version-control-with-git--ud123)
13+
* [Dangit, Git!?!](https://dangitgit.com/en)
14+
15+
## ./missing-semester
16+
17+
We recommend to check out [The Missing Semester of Your CS Education](https://missing.csail.mit.edu/), a class taken at MIT with around nine topics which would help you "master the command-line, use a powerful text editor, use fancy features of version control systems, and much more!". It's available both as lecture notes and video recordings, so be sure to check it out!
18+

‎responsibilities/junior-mentors.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Junior Mentors
2+
3+
**To students**
4+
5+
* Help beginners with doubts while getting started with coding, IDEs, git, GitHub, etc
6+
* Make sure students aren't stuck, if they're get in touch with them
7+
* Give them constructive feedback, be patient and respectful
8+
* Keep in touch \(check your notifications on GitHub, Discord, etc at least once a day\)
9+
10+
**To program managers**
11+
12+
* Inform when availability will be reduced
13+
* Inform if there are issues with a student \(communication, progress, etc\)
14+
* Lead weekly stand-ups
15+

‎responsibilities/mentors.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Mentors
2+
3+
**To students**
4+
5+
* Help them communicate freely and in the open
6+
* Give them constructive feedback, be patient and respectful
7+
* Teach them how to ask good questions and get answers
8+
* Help them out with doubts
9+
* Follow best practices while reviewing their code
10+
* Don't merge a pull request until at least **two** mentors have approved the code
11+
* Suggest them good resources
12+
* Keep in touch \(check your notifications on GitHub, Discord, etc at least once a day\)
13+
14+
**To program managers**
15+
16+
* Inform when availability will be reduced
17+
* Inform if there are issues with a student \(communication, progress, etc\)
18+
* Provide us feedback regarding the program
19+
* Lead weekly stand-ups
20+
21+
\*\*\*\*
22+

‎responsibilities/students.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Students
2+
3+
* Actively participate in the program
4+
* Ask for help when something is preventing you from achieving a goal
5+
* Ask your question in the open if it could be beneficial to someone else too
6+
* Look for answers yourself before going to the mentors for help
7+
* Don't say just ["hello"](https://www.nohello.com/) in the chat
8+
* Help other fellow students with their doubts
9+
* Listen and respond to feedback, especially during reviews
10+
* Submit quality code and follow best practices \(your mentors would help\)
11+
* Don't merge a pull request until at least **two** mentors have approved the code
12+
* Keep in touch \(check your notifications on GitHub, Discord, etc at least once a day\)
13+
* Regularly participate in the weekly stand-ups
14+
* Provide us feedback in the forms we will be sharing
15+

0 commit comments

Comments
 (0)