Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 3.16 KB

README.md

File metadata and controls

38 lines (27 loc) · 3.16 KB
Raw

Welcome Github Scribes!

First, start by reading this overview doc of using GitHub for a Community Sprint project: https://salesforce.quip.com/IxfrAoa4wTpX

What is a Github Scribe? A Github Scribe is a single member of a project team responsible for keeping the project repository up-to-date for the duration of the Sprint (i.e. someone who will be creating or editing the Readme or Wiki pages). Project Leaders will identify a Scribe on Day 1 of the Sprint.

Best Practice to ensure you understand your role during the Sprint:

👉 We HIGHLY recommend that you and your project team Watch your Project's repo!
Watching your projects repository allows you to receive notifications for new pull requests and issues that are created. Click here to learn more!

👉 Your Project's README file and/or Wiki should be kept up to date both during and after the Sprint so that we know what you worked on and who was on the team.
Review our Sample README file as a reference.

👉 Use your project repository Wiki to store your project documentation
Every GitHub repository comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project. Take a look at Github's About wikis page for more information.

👉 Use the Welcome Wiki for helpful tips & tricks!
The Wiki provides links to a list of resources to help you navigate through your Sprint experience in Github.

👉 Markdown is your friend for text style formatting
When editing your README.md file (or any file that ends with .md or .markdown) you will be using Markdown language. Be sure to access the Mastering Markdown Github guide to help you understand the different formatting options that are available. If you don't feel comfortable using Markdown feel free to use the Docs to Markdown Chrome Extension.

Optional: Create a Directory folder in your project Repository in support of Wiki images

You will use this directory to stores images (if any) for use with your repo's Wiki.

  1. From your Project's repository click on Create new file
  2. Type in the name of the Directory you want to create follwed by a slash (/) follwed by the name of the file that will identify what types of information will be housed here

Here is an Example:
Wiki Documentation/Images.md

  1. In the Edit new file tab add the following message: "This directory will be used to store images in support of wiki documentation efforts."
  2. Add a message in the Commit new file section at the bottom of the file

Here is an Example:
Wiki Images Directory
Created a Documentation directory to store images for the wiki

  1. Commit Changes when done