Quest Issue: Content for the Contribution Guides

[jayjayjpg]

This quest issue is related to the Contribution Guides RFC

Motivation

In the context of the Contribution Guides RFC we require content for the first release of the website. Several topics about open-source, project interaction and workflows are supposed be covered as part of this first pass of a curriculum.

Who can work on this issue?

We need volunteers who

• have basic knowledge of using Markdown
• have a basic knowledge of using Git
• are up to write about contribution and open-source

How can I work on this issue?

Take a look through the list of topics and claim an open one by mentioning that you'd like to work on it in the comments below. Once a sub topic is claimed, the task will be locked for a week to be worked on by the person who volunteered. Please only claim a single issue at a time. An issue will be marked as done as soon as a relevant PR covering the topic item has been merged.

List of Topics

Introduction

• Introduction / Index : Write one or several paragraphs about what Ember is and how the project relates to Open Source (🔏 @jessica-jordan)
• Introduction / Index: Write one or several paragraphs about what open-source is, its benefits for projects and the community
• Introduction / Index: Write one or several paragraphs about why someone should contribute to open source, what the benefits + challenges of becoming an OSS contributor are and a few encouraging words about why each contribution matters

Find a Project

• Find a Project / Types of Contribution: Write one or several paragraphs about why Ember encourages different kinds of contributions to the project
• Find a Project / Types of Contribution: Create a list of all different types of contribution to the project and the community with relevant links to already existing resources (e.g. Organize a meetup with a link pointing to https://emberjs.com/community/meetups)
• Find a Project / Start a Project: Write one or several paragraphs about why someone might want to start their own project if they weren't able to find an already existing initiative. This section might want to mention things like how to create an addon or create a screencast series. Please provide relevant links to existing resources to learn where possible

Make a Contribution

• Make a Contribution / Index: Write at least one paragraph about why writing issues on a Github repository of an Ember project is important and how it helps other contributors. Be sure to include some encouraging words for first time contributors in particular. Looking for inspiration? Be sure to check out the particular question "What's your advice for first-time contributors" from each of the interviews in the Contributor Interview Series

• Make a Contribution / File an Issue: Write a detailed Guide on how to file an issue on a Github repo of the Ember org. Please mention concepts as searching for already existing issues, finding a suitable issue title, how to write a clear description for a bug or feature request, how to use labels and how to check back on comments to an issue. Please add high-resolution screenshots for each of the different UI steps for creating and submitting an issue

• Make a Contribution / How to Git: Explain how to setup your local environment for a code contribution, including: Git Installation on Windows / Mac / Linux, forking a repo, check out a forked repo

• Make a Contribution / How to Git: Explain how to create a feature branch, edit files and add these changes via Git, how to commit changes and write descriptive commit messages, how to push the feature branch to a remote of a forked repo

• Make a Contribution / How to Git: Explain how to open a pull request from a feature branch, how to request reviews for a PR and how to communicate during code review. Please also explain the basics of branch checks (e.g. via Travis CI) and the meaning of the approved / commented / requested changes PR states. Be sure to remind readers that feedback on a PR is helpful and a friendly attitude, as well as checking back on their open PRs goes a long way in making their contribution a success. It might also be worth noting that everyone, and especially the reviewer, is there to help.

• Make a Contribution / Making Code Contributions: 2 examples of project specific contributions (e.g. Ember + Ember CLI). For reference, be sure to check out the Contributing guides of both Ember.js and Ember CLI

• Make a Contribution / Making Code Contributions: Describe where to find project specific guidelines (CONTRIBUTING.md) for each particular project. Be sure to also mention how to get into contact with project maintainers either via Github or the Ember Discord server. Also be sure to describe when and where to ask for more guidance on an already open pull request or when starting work on a new issue

• Make a Contribution / Writing RFCs: Process of RFC writing and discussion

[jayjayjpg]

I'd like to work on Introduction / Index : Write one or several paragraphs about what Ember is and how the project relates to Open Source - I can send a PR in in the following days ✨

[jenweber]

We have a minimal contributing guide here: https://guides.emberjs.com/release/contributing/

This is still a good project to do, since there are so many things to know!