open_source_guidelines.md

Open Source Guidelines

Role	Editor
Phase	N/A
Qualifications	N/A
Objectives	Provide guidelines on open source policies and content formatting
Resources	Github Writer Chrome Extension Creative Commons Zero License Basic Writing and Formatting Syntax for Github Wikipedia: Citations
Linked to	Template Document
Linked from	Project Overview

Synopsis

Psychepedia is evidence-based and process-driven. Information is presented as a series of steps with clearly defined objectives, qualifications, resources, and evidence. There are two types of documents: Guides and Resources. Guides are process-driven while resources are ancillary material. This document provides guidelines for the formatting, editing, and inclusion of content. All content on Psychepedia is subject to the Creative Commons Zero License.

Process

Install the Github Writer Extension

This Chrome extension will provide a WYSIWYG editor for modifying Github .md files. The extension will make it easier to format documents in the Chrome browser. Optionally, you can use Github Markdown syntax instead.

1. Install the Github Writer Chrome Extension
2. Navigate to a .md file such as this one
3. Click the Edit pencil icon
4. Confirm that the extension is working when the editing toolbar appears

Edit an Existing Document

1. Navigate to the appropriate folder in the Psychepedia repository on Github
2. Click the Edit pencil icon
3. Make edits
4. Add a title and description to the commit

Create a New Document

1. Navigate to the appropriate folder in the Psychepedia repository on Github
2. Click Add file button
3. Title the file and conclude the file with the .md extension
   1. The file will become a URL. Therefore, use _ instead of spaces and do not include non-standard characters
4. Commit & review changes
   1. This creates the document and will enable the Github Writer extension upon editing (of a .md file)
5. Click the Edit pencil icon
6. Create a branch for the commit and start a pull request

Begin Each Document With Background Info

1. Create a table or copy the Guide Document Template
2. Fill in the table's information as follows:

Role	Who this guide is for. i.e., Journeyer, Practitioner, or Operator
Phase	The phase of the journey. i.e., Preparation, Journey, or Integration
Qualifications	What is necessary to undertake this guide. e.g., prior reading, a prior experience, etc.
Objectives	What are the promises of undertaking this guide. e.g., develop trust and surrender to allow the Inner Healing Intelligence to do its work with the least friction.
Resources	Additional resources. e.g., books, websites, etc.
Linked to	Links to other documents in Psychepedia
Linked from	Links from other documents in Psychepedia

  3. Add a synopsis that describes what the guide details under a Synopsis header 2

Format Guide Documents as Processes and Steps

Guides are formatted as actionable steps that begin with verbs. Background information can be provided as sub-points in each step.

1. Title each process with a header 2
2. Provide background information for the process
   1. Background information can include objectives, resources, and other information relevant to helping the reader understand the purpose of the process. This is an example.
3. Number each step in the process
4. Begin each step with a verb. Optionally, conclude each step with a reason
   1. e.g., Open the container with a vulnerable introduction to set a standard of trust and vulnerability for your peers

Cite All Sources

This Project is evidence-based, meaning that all content requires sourcing. Sources may be primary sources, especially in the case of indigenous wisdom.

1. Conclude each document with a Sources header 1
2. Cite each source using the Wikipedia format for citations

Submit Document for Approval

1. Format the document according to the processes outlined here
2. Ensure all sources are cited
3. Commit & review changes
4. Create a branch for the commit and start a pull request