CONTRIBUTING.md

ACES Software Aids

This is a repository for the front-end of the Software Aids project. 👋

##PLEASE WATCH THIS VIDEO FOR A COMPLETE GUIDE https://youtu.be/p2z3frymoiU

Setup 🎯

Firstly, you have to fork the repo before you clone the repo using:

git clone *repo URL here (without asterisks)*

Contributions

‼️ Version Control Conventions (IMPORTANT! Make sure you read this before you contribute!) ‼️

• Create a new branch for every feature you add.
• Push and create a pull request to the dev branch.
• Do not push directly to main, dev or deploy branches!
• Use snake_case for branch names.
• Write descriptive commit messages.
• Explain what you did in a few words in your pull request comment.
• Never merge or close a PR by yourself - one person is solely responsible for handling this to avoid confusion!

Style Conventions ✍️

You'll see the folder structure and file naming standards, please abide by them.

• Create a folder for the page you're working on in the pages folder.
• Create css, images, js files within the appropriate folders.

Below is a sample of the folder structure:

 |-- assets
    |-- icons
    |-- img
    |-- css
    |-- vendor

 |-- pages
     -signup.html
    

• Create all JS files in the js folder

• Images & icons go in the images & icons folders respectively.

• Use lowercase letters for file names.

• Use hyphens for naming CSS-classes and IDs, eg header-section. Use readable names.

• For Javascript functions/variables, use the snake_case naming convention.

• Please remember to write comments so that others can follow.

Style Guide Examples 📖

• If you're unsure about code style, follow the style guides.
• Link to a JavaScript style guide (AirBnB).
• Link to an HTML/CSS style guide (Google).
• Please go through the style guides at least once!

Thank you and well done for contributing! 👏

ACES Software Aids

This is a repository for the front-end of the Software Aids project. 👋

Setup 🎯

Firstly, clone this repo using:

git clone *repo URL here (without asterisks)*

Contributions

‼️ Version Control Conventions (IMPORTANT! Make sure you read this before you contribute!) ‼️

• Create a new branch for every feature you add.
• Push and create a pull request to the dev branch.
• Do not push directly to main, dev or deploy branches!
• Use snake_case for branch names.
• Write descriptive commit messages.
• Explain what you did in a few words in your pull request comment.
• Never merge or close a PR by yourself - one person is solely responsible for handling this to avoid confusion!

Style Conventions ✍️

You'll see the folder structure and file naming standards, please abide by them.

• Create a folder for the page you're working on in the pages folder.
• Create css, images, js files within the appropriate folders.

Below is a sample of the folder structure:

 |-- assets
    |-- icons
    |-- img
    |-- css
    |-- vendor

 |-- pages
     -signup.html
    

• Create all JS files in the js folder

• Images & icons go in the images & icons folders respectively.

• Use lowercase letters for file names.

• Use hyphens for naming CSS-classes and IDs, eg header-section. Use readable names.

• For Javascript functions/variables, use the snake_case naming convention.

• Please remember to write comments so that others can follow.

Style Guide Examples 📖

• If you're unsure about code style, follow the style guides.
• Link to a JavaScript style guide (AirBnB).
• Link to an HTML/CSS style guide (Google).
• Please go through the style guides at least once!

Thank you and well done for contributing! 👏