azurize / start-here-guidelines

Lets Git started in the world of opensource, starting in the Zero To Mastery's opensource playground. Especially designed for education and practical experience purposes.

One rule of this community:

We don't care if you break things. This is a playground, and we encourage failing often. Use this as a practice ground, and enjoy contributing to projects you create with your fellow students. Many students have gained real-world experience "working in teams" by working on these projects.

A Guide to Get Started (used to be the 4 step guide)

1. Check out Andrei's videos on github if you haven't watched it already.

2. On the GitHub page for this repository, click on the button "Fork."

   

3. Clone your forked repository to your computer:

   

   For example, run this command inside your terminal:

   git clone https://github.com/<your-github-username>/start-here-guidelines.git

   Replace <your-github-username>!

   Learn more about forking and cloning a repo.

4. Shift to project directory:

   cd start-here-guidelines

5. Before you make any changes, keep your fork in sync to avoid merge conflicts:

   git remote add upstream https://github.com/zero-to-mastery/start-here-guidelines.git
   git pull upstream master

   If you run into a merge conflict, you have to resolve the conflict. There are a lot of guides online, or you can watch this tutorial.

6. After adding the upstream and checking that all files are up to date, we now will create new branch before editing any files. There are two ways to do so:

   git checkout -b <branch-name>

   git branch <branch-name>
   git switch <branch-name>

7. On your computer, open your text editor, and add your name to the CONTRIBUTORS.md file.

• ⚠️ IMPORTANT NOTE #1: Add your name somewhere in the middle. Not at the top or bottom in order to avoid the chance of you getting a merge conflict!
• ⚠️ IMPORTANT NOTE #2: Please do NOT edit or remove other people from the list, even to fix their indentation etc. This will likely prevent your PR from being merged.

8. Add the changes with git add, git commit (write a good commit message, if possible):

   git add CONTRIBUTORS.md
   git commit -m "Add <your-github-username>"

   Replace <your-github-username>!

9. Push your changes to your repository:

   git push origin <branch-name>

10. Go to the GitHub page of your fork, and make a pull request:

    

    Read more about pull requests on the GitHub help pages.

11. Wait until Zerobot or one of the maintainers merges your pull request. If there are any conflicts, you will get a notification and be required to resolve the conflict.

12. Go join a project and start contributing or create your own group apps. Don't be shy and enjoy creating things together (We have over 20 projects for all levels of programmers)! Check out this guide for more information on selecting a project.

13. To see the Zero to Mastery Icon in your GitHub profile, follow these steps (you must complete steps 1 and 2 for this to work).

Anatomy of an open-source project:

Every open-source community is different.

Spending years on one open-source project means you’ve gotten to know one open-source project. Move to a different project, and you might find the vocabulary, norms, and communication styles are completely different.

That said, many open-source projects follow a similar organizational structure. Understanding the different community roles and overall process will help you get quickly oriented to any new project.

A typical open-source project has the following types of people:

Author: The person(s) or organization that created the project.

Owner: The person(s) who has administrative ownership over the organization or repository (not always the same as the original author).

Maintainers: Contributors who are responsible for driving the vision and managing the organizational aspects of the project (may also be authors or owners of the project).

Contributors: Everyone who has contributed something back to the project.

Community Members: People who use the project. They might be active in conversations or express their opinion on the project’s direction.

Bigger projects may also have subcommittees or working groups focused on different tasks, such as tooling, triage, community moderation, and event organizing. Look on a project’s website for a “team” page or in the repository for governance documentation to find this information.

A project also has documentation. These files are usually listed in the top level of a repository.

LICENSE: By definition, every open-source project must have an open-source license. If the project does not have a license, it is not open source.

README: The README is the instruction manual that welcomes new community members to the project. It explains why the project is useful and how to get started.

CONTRIBUTING: Whereas READMEs help people use the project, contributing docs help people contribute to the project. It explains what types of contributions are needed and how the process works. While not every project has a CONTRIBUTING file, its presence signals that this is a welcoming project to contribute to.

CODE_OF_CONDUCT: The code of conduct sets ground rules for participants’ behavior and helps to facilitate a friendly, welcoming environment. While not every project has a CODE_OF_CONDUCT file, its presence signals that this is a welcoming project to contribute to.

Other documentation: There might be additional documentation such as tutorials, walkthroughs, or governance policies, especially on bigger projects.

Finally, open-source projects use the following tools to organize discussion. Reading through the archives will give you a good picture of how the community thinks and works.

Issue tracker: Where people discuss issues related to the project.

Pull requests: Where people discuss and review changes that are in progress.

Discussion forums or mailing lists: Some projects may use these channels for conversational topics (for example, “How do I…“ or “What do you think about…“ instead of bug reports or feature requests). Others use the issue tracker for all conversations.

Synchronous chat channel: Some projects use chat channels (such as Discord or IRC) for casual conversation, collaboration, and quick exchanges.

Get all the ZTM Courses, for one monthly subscription here.