Skip to content

Latest commit

 

History

History
executable file
·
32 lines (18 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
32 lines (18 loc) · 1.94 KB

Contributing to The Open Source Way

We aim to make contributing to The Open Source Way a pleasant and enriching experience for all project participants, and we welcome contributions of all kinds.

Getting started

1. Review outstanding issues

  • Check the list of outstanding issues to identify something project needs and you'd like to offer.
  • Alternatively, see one of the projects various work boards to get a sense of tasks-in-progress that could use your help.

2. Raise your hand

  • Once you've found an issue you can help us address, join the conversation about it. Project maintainers and guidebook editors will want to know who's volunteering to add new material or assist with

3. Start working

Editorial tasks

If you've selected an editorial task, you can start contributing immediately.

  • Refer to the project style guide (updated regularly) for pointers—but don't let small details slow you down. An editor will help you polish your work before it's finished.
  • Begin by forking the project repository and adding material on a topic of your choice to its respective chapter. Then submit a pull request outlining your changes so an editor can review what you've added and work with you to polish it.
  • Alternatively, propose edits to a guidebook chapter directly in your browser. Select a file in the project repository by clicking on it. Locate and click the pencil icon at the top of every file in the repository. Make chages to the file in your browser, then submit that file for review.

Technical tasks

  • [Update with instructions for performing technical tasks]

Marketing tasks

  • [Update with instructions for performing marketing tasks]