Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.92 KB
Raw

Create a Coding Task Article

Coding Tasks is a community driven collection of standard coding tasks for various platforms and frameworks.

Task Details

  • Platform: Coding Tasks
  • Development Hours: 30 mins - 4 hours
  • Task Type: Base

Task Objectives

  • Article Published on Coding Tasks

Instructions

  1. Fork Coding Tasks Repo
  2. Search the existing pull requests, to see if anyone else is working on that task.
  3. Create a folder in the appropriate platform directory, for the task you are documenting, with a placeholder README.md file.
  4. Create a Pull Request to neverbehind/codingtasks to communicate that you are working on that task.
  5. Compose article following the Article Template below.
  6. Save the article in the README.md in the folder you created for the task.
  7. Add sample code in your task folder.
  8. Add an entry into the index/README.md linking to your new task folder.
  9. Commit and Push the changes up to the repo.
  10. Update the Pull Request with a comment that it is ready to merge in.

Article Template

# [Task Name]

[Task Description]
      
## Task Details  
**Platform/Framework:** [Platform]  
**Development Hours:** 30 mins  
**Task Type:** Base  
    
## Pre requirements
[List of Tasks that you will need to have performed to accomplish this task]
 
## Task Objectives
[List of Deliverables]
 
## Instructions
The instruction area should lay out the parts of code that need to be in place as well as a big picture of how 
these pieces fit together. 
 
Code Snippets (Use ``` for formatting)
Code Examples - should be full working examples committed under the task folder     
 
## Research and Useful Links Section
[If there are any helpful links that have helped]

Mark Down Syntax

Github Guide