Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

80 lines (62 loc) · 2.61 KB

How to contribute to Society of Coders

This project is created by community contributions. Creating an post is very simple and takes less than 3 minutes.

Step 1

Fork this repository.

Step 2

Create a markdown (.md) file under the section of your article in the data subfolder. For example if you are a new article to "gotchas" create a new file here.

Warning: The filename will be used as a url path so it can only contain chars 'a-z', 'A-Z', '0-9', or '-'.

Copy and paste the following into your newly created file.

---
title: 'Put your article title here'
date: 'MM-DD-YYYY'
class: 'CS*' # CSA or CSP
section: 1 # A number to represent Unit or Big Idea (optional for pbl)
keywords: 'keyword1, keyword2 ...' # Keywords to describe your project seperated by commas
tech: 'tech1, tech2, tech3...' # What you used (Language, frameworks, Database) seperated by commas (only for pbl)
author: 'Your name' # Optional
authorLink: 'https://github.com/your-github-here' # Optional 
---

Your content in markdown will go here.

Tips:

  • The name of your markdown file is <,25 chars long.
  • The title field must be < 70 chars.
  • Section is not needed for PBL.
  • The body of the article doesn't have to be very long, the more compact it is the better it is for studying.
  • Preview markdown articles before pushing to make sure the formatting is as intended

CSA Units:

  • Unit 1: Primitive Types
  • Unit 2: Using Objects
  • Unit 3: Boolean Expressions and if Statements
  • Unit 4: Iteration
  • Unit 5: Writing Classes
  • Unit 6: Array
  • Unit 7: ArrayList
  • Unit 8: 2D Array
  • Unit 9: Inheritance
  • Unit 10: Recursion

CSP Big Ideas:

  • Big Idea 1: Creative Development 10–13%
  • Big Idea 2: Data 17–22%
  • Big Idea 3: Algorithms and Programming 30–35%
  • Big Idea 4: Computer Systems and Networks 11–15%
  • Big Idea 5: Impact of Computing 21–26%

Here is an example of a completed post.

Step 3

Commit and push your changes and open a pull request to the main repository. It will be reviewed and added to the website.

Tips:

  • If your fork ever falls behind the master repo use the "fetch upstream" feature to sync back up