Coder Social home page Coder Social logo

sandipguchait / start-here-guidelines Goto Github PK

View Code? Open in Web Editor NEW

This project forked from zero-to-mastery/start-here-guidelines

0.0 1.0 0.0 52.76 MB

Guidelines on how this open source community works

Home Page: https://zero-to-mastery.github.io/start-here-guidelines/

License: MIT License

start-here-guidelines's Introduction

start-here-guidelines

Guidelines on how this open source community works. Most information is from the amazing https://opensource.guide/how-to-contribute/

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.

4 Step guide to get started:

1. Read the wonderful gitStarted Guide by our fellow student @wanraitelli

2. Make your first Pull Request (Free how-to tutorial at http://makeapullrequest.com/, and then check out Andrei's videos on github https://www.udemy.com/the-complete-web-developer-in-2018/learn/v4/t/lecture/8725782/), by adding your name to the CONTRIBUTORS.md file in the start-here-guidelines project. (You can also use this walkthrough as a reference: https://github.com/Roshanjossey/first-contributions)

3. Go join a project and start contributing. This is a community to experiment and see what we create. Don't be shy and enjoy creating things together! Explore The Projects and also check out this guide for more information.

4. In order to see the Zero to Mastery Icon in your Github profile, follow this: https://help.github.com/articles/publicizing-or-hiding-organization-membership/

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. (They 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 associated 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.

start-here-guidelines's People

Contributors

abdus avatar agpt8 avatar ahmedas22 avatar aneagoie avatar arduino731 avatar arwasowski avatar asciimancer avatar bgongre avatar charlesscheuer avatar cyrilseangalam03 avatar dhaval1403 avatar drood87 avatar ea5 avatar ej94 avatar googlr avatar justinwlin avatar mikesinc avatar naveen-ku avatar noaimi avatar orinayo avatar pengyongxin123 avatar psdcode avatar rahuls321 avatar rizaneeves avatar royranger avatar samirjouni avatar sjwdevguy2 avatar tzuhanliang avatar wanraitelli avatar yitzhak-bloy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.