Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 2.19 KB

Contributing

See 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 with the details of the project.

Title: [summary of project]

Summary: A couple sentences describing the project.

Expected Outcome: A clear outcome, where the answer to "Was the project successful?" is "yes" or "no".

Skills: list of languages, frameworks, or expertise

Relevant issues: [urls to issues]()

Mentors: @username

For example:

Title: Improve Atom's parser performance

Summary: Make the Atom parser faster and better at handling large files and long lines. This includes identifying bottlenecks, developing benchmarks, and possibly re-writing parts of the existing code base in C++ if needed.

Expected Outcome: Improved speed opening files and the 2MB file limit can be increased or > emoved.

Skills: CoffeeScript, JavaScript, C, C++

Relevant issues: atom/atom#979 and atom/atom#1667

Mentors: @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:

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: