Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 3.58 KB

style-guidelines.md

File metadata and controls

47 lines (38 loc) · 3.58 KB

LEARN Syllabus Contributor Guidelines

At LEARN, our syllabus is open-source information reflecting the current status of the curriculum. Just like the technology we teach, the syllabus is ever evolving and adapting to suit the needs of our students. The repository is maintained by the LEARN instruction staff.

If you would like to contribute to our syllabus, please review the following:

Making a Contribution

  • Find an error or issue that you are interested in addressing.
  • Clone the main LEARN syllabus to your local machine.
  • Create a new branch for your fix using git checkout -b descriptive-branch-name-here.
  • Make the appropriate changes that correspond with your branch name.
  • Commit your changes with a short, but descriptive message.
  • Push the changes to the repository using git push origin descriptive-branch-name-here.
  • Submit a pull request.
  • Title the pull request with a short description of the changes made.
  • In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
  • Wait for the pull request to be reviewed by a maintainer.
  • Make changes to the pull request if the reviewing maintainer recommends them.
  • Celebrate your success after your pull request is merged!

Technologies

Style Guide

  • Text instructions are written in first person plural.
  • Language and framework names referenced in text instructions are capitalized ex) JavaScript, React, Ruby, PostgreSQL.
  • Vocabulary words are bold when appearing with their definitions.
  • Terminal commands in text instructions are wrapped in single back ticks.
  • File paths in text instructions are in italics.
  • All variables have descriptive names.
  • No spaces around HTML/JSX attributes ex) <div className="main">.
  • One space around JavaScript and Ruby operators ex) 8 + 5.
  • All JavaScript strings are in double quotes unless necessary for punctuation.
  • All Ruby strings are in single quotes unless necessary for punctuation.
  • Semicolons are not used in JavaScript code unless necessary.
  • Code is formatted into its own distinct block with triple back ticks and styled with the name of the language in all lowercase.
  • File paths appear above code blocks in italics.

Need Help?

If you need help, you can ask questions on our LEARN community slack channel or at contact@learnacademy.org.

LEARN Code of Conduct

We at LEARN pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We strive to be a positive voice in the Tech Community. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community-oriented learning environment.

Exclusionary or inappropriate content is unacceptable. Your work and decisions affect others and your actions have consequences. Violating our policy will result in a temporary or permanent ban from all LEARN community platforms.