Skip to content

Educational and refresher resources for DevDogs members to confidently tackle our projects, no matter their role.

Notifications You must be signed in to change notification settings

DevDogs-UGA/DevDogs-Academy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 

Repository files navigation

Purpose

The purpose of DevDogs Academy is to fulfill one of our primary goals: helping members take what they’ve learned in the classroom and apply it to real-world contexts. DevDogs Academy provides articles that meet UGA students at their base CS-1301/2 level of understanding and build upon the concepts they know in a software development context. Whether a member is new to software development or a seasoned professional, DevDogs Academy hopes to refine critical development skill sets ranging from project management and coding to career and user experience.

Contributing*

DevDogs Academy is intentionally open-sourced so that anyone can learn and anyone* can help others do so. Before making a change, we encourage you to check out the repository’s Project page to see where your help may be needed the most. Don’t see something up your alley? Start a discussion in our Discord server.

How to Contribute

When you’ve determined what you’d like to contribute, please follow the steps below to make a change: WIP

Contribution Guidelines

As you’re making your changes, please adhere to the guidelines below. Failure to adhere to them may result in denial of your pull request:

  • Avoid spelling, grammatical, syntactical, or technical errors.
  • Use Markdown for formatting.
    • A great guide to Markdown's syntax guide can be found here.
  • Organize concepts in a logical manner.
    • A fantastic example of Markdown-based tutorials hosted on GitHub is DevDogs Academy’s inspiration, found here.
  • Write for an audience of people who have passed at least the introductory class in the relevant course progression.
    • For example, programming articles should be written with students who have passed UGA’s CSCI 1301 class in mind.
    • Topics that a student who has passed CSCI 1301 at UGA should know can be found here.
  • Avoid writing a novel, but be thorough in your explanations
    • Find a happy medium between brevity and deep-dives.
  • Employ different types of supplemental media into your article such as images, graphs, or video references.
  • End with an “Additional Resources” section linking external articles for further learning.

*Only people currently participating in DevDogs can contribute to DevDogs Academy articles.

About

Educational and refresher resources for DevDogs members to confidently tackle our projects, no matter their role.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published