Update contributing guidelines

This commit is contained in:
Brandon Keepers 2016-02-18 13:55:39 -05:00
Родитель 1887c354be
Коммит 32a3422dc4
2 изменённых файлов: 65 добавлений и 3 удалений

58
CONTRIBUTING.md Normal file
Просмотреть файл

@ -0,0 +1,58 @@
# Participating in GitHub Open Source Mentorships
See [README.md](README.md) for information on applying for a mentorship.
## Volunteering to Mentor
**This is for GitHub employees.**
If you are interested in mentoring on an open source project that you maintain or contribute to, [open an issue](https://github.com/github/mentorships/issues/new) with the details of the project.
```
Title: [summary of project]
Summary: A couple sentences describing the project.
Expected Outcome: A clear outcome that
Skills: CoffeeScript, JavaScript, C, C++
Relevant issues: [urls to issues]()
Mentors: @username
```
For example:
> title: Implement support for non-US keyboard layouts in Atom
>
> Investigate and implement ways to better support non-US keyboard layouts in the Atom text editor. This would greatly improve the editing experience for anyone using a non-US keyboard layout. This will include engaging with the community to identify the root problem and working through multiple solutions from patching Chromium to crowd-sourcing custom keybinding layouts.
>
> Expected Outcome: Using Atom with a non-US keyboard layout will be a better experience.
>
> Skills: CoffeeScript, JavaScript
>
> Relevant issues: [atom/atom-keymap#35](https://github.com/atom/atom-keymap/issues/35) and [atom/atom-keymap#37](https://github.com/atom/atom-keymap/issues/37)
>
> Mentors: [@kevinsawicki](https://github.com/kevinsawicki)
Mentoring is incredibly rewarding, and providing a positive experience for both you and the student is an big commitment that is not to be taken lightly. Please talk to your team before volunteering.
Mentoring Resources:
- [Outreachy's info for Mentors](https://wiki.gnome.org/Outreachy/Admin/InfoForMentors)
- [Google Summer of Code Mentor's Guide](http://en.flossmanuals.net/GSoCMentoring/what-is-gsoc/)
## Managing Issues
Issues in this repository are used to take questions from potential contributors, manage the programs we participate in, and the projects available for mentorship.
Labels:
- [question]
- [project]
- [program]
[project]: https://github.com/github/mentorships/labels/project
[program]: https://github.com/github/mentorships/labels/program
[question]: https://github.com/github/mentorships/labels/question

Просмотреть файл

@ -1,5 +1,9 @@
# Google Summer of Code
# GitHub Open Source Mentorships
GitHub is the world's largest code repository and home to countless open source projects, including many that we actively participate in.
GitHub is the world's largest code repository and home to countless open source projects, including many that we actively contribute to. We also participate in several open source mentorship programs.
These ideas are suggestions that we think would make good Google Summer of Code projects. They are only meant to be a starting point. Check out our [proposal template](proposal-template.md), and feel free to [open an issue](https://github.com/github/gsoc/issues/new) to ask questions or discuss other ideas.
If you are looking for an opportunity to work on an open source project with a GitHub member, please apply through one of the available [programs][program] and look through the suggested [projects][project]. Feel free to [open an issue](https://github.com/github/mentorships/labels/question) to ask questions or discuss other ideas.
[project]: https://github.com/github/mentorships/labels/project
[program]: https://github.com/github/mentorships/labels/program
[question]: https://github.com/github/mentorships/labels/question