A project repository is your Sprint projects' home. It's a place where all of your project files (documentation, user-stories, code, etc.) will live so that others in the open source community (including Salesforce.org) can have open access to all your work in order to track progress. A repository has the added benefit of allowing future contributors to continue the work started at this Sprint.
- Navigate to https://github.com/SFDO-Sprint-2019-Amsterdam (right click this URL and open a new page)
- Click the New button (Green button)
- From the Create a new repository page fill in the requested information
Here is an Example:
Repository name: Admin Soft Skills
Description: Salesforce Administrators have the technical skill set to perform the functions of an administrator but many entering the Salesforce.org community lack the soft skills set required to be a successful and impactful administrator. This skills gap within the administrator community is bad for nonprofits, higher ed, partners and the community at large.
Public Repo = true
Initialize this repository with a README = true
Add .gitignore: None (leave this as is)
Add a license = BSD 3-Clause "New" or "Revised" License
Click the Create Repository button
Step 2: Update your Repository README file using our Project README template
A README is the start of your projects documentation on GitHub. Documenting any open source project should always begin with a good README so that potential users can understand what your work is about.
After you copy and paste the template into your Project's README.md file be sure to do the following:
- Add a message in the Commit changes section at the bottom of the README.md file
Here is an Example:
Update README.md
Updated the README.md file using the Project README template
- Ensure Commit directly to the master branch = true
- Click Commit new file
Note: When editing your README.md file (or any file that ends with .md) 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: https://guides.github.com/features/mastering-markdown/
Your Project's README file must be kept up to date. Doing so ensures that anyone reviewing your project repositiory (during or after the Sprint) understands the current state of your project which supports trust, transparency, and collaboration from the open source community.
Step 3: Create a Directory folder in your project Repository to house any documentation generated during the Community Day event.
- From your Project's README.md file click on Create new file
- 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:
Documentation/Project Documentation
- In the Edit new file tab add the following message: This directory is where all project documentation will be housed.
- Add a message in the Commit new file section at the bottom of the file
Here is an Example:
Documentation Directory
Created a Documentation directory for all Project Documentation
- Ensure Commit directly to the master branch = true
- Click Commit new file