Create a Development Standards Document

bazakeliad commented 4 weeks ago

Overview

The team member assigned to this task should conduct research to identify the best practice for developing a web project. To develop like seniors, we need to establish clear standards. This project should adhere the following standards:

Naming Conventions: (Folder/File name, function, classes, variables, branches)
Git Commit, PR, (number of approvals), review & branches.
How to develop (Short example that shows how to add a function/class/etc). (optional)

DOD

[x] Create wiki blog on Git workflow
[ ] Create wiki on Code conventions and Best Practices

Merge Requests

BenEpstein commented 4 weeks ago

@arielba2002 I would like to mainly focus on the 2nd bullet point.

Are you good with focusing on the Naming convention bullet point? I think it includes going over best practices for HTML, CSS and JS and then create a list of bullet points on how it should be done + some good links for examples online.

What do you think is best?

bazakeliad commented 4 weeks ago

@arielba2002 I would like to mainly focus on the 2nd bullet point.

Are you good with focusing on the Naming convention bullet point? I think it includes going over best practices for HTML, CSS and JS and then create a list of bullet points on how it should be done + some good links for examples online.

What do you think is best?

Naming conventions mainly focuses on how to name all different "objects" in code.

For example: All classes should be named using PascalCase. This means that each word in the class name should start with an uppercase letter, and there should be no underscores between words.

Examples:

•   UserProfile
•   OrderProcessor
•   DatabaseConnection

arielba2002 commented 4 weeks ago

@BenEpstein I have no problem working on Naming conventions. About the third bullet point, let's see if one of us at least finish working on his bullet point. I suggest we will work on the third bullet point only if we have extra time. What do you think?

BenEpstein commented 4 weeks ago

Yep. Awesome king👑

BenEpstein commented 3 weeks ago

Created a Wiki document on how to work with Git. @all need to review it!

See Wiki here - Working-with-Git-as-a-team

bazakeliad commented 3 weeks ago

Created a Wiki document on how to work with Git. @ALL need to review it!

See Wiki here - Working-with-Git-as-a-team

Looks good, well done! I think that we should apply protection rules to the project (can't merge without at least 1 approval, can't push directly to main branch, etc).

BenEpstein commented 3 weeks ago

Created a Wiki document on how to work with Git. @ALL need to review it! See Wiki here - Working-with-Git-as-a-team

Looks good, well done! I think that we should apply protection rules to the project (can't merge without at least 1 approval, can't push directly to main branch, etc).

Sounds good, I agree. I think because you're the owner of this project, only yo can set it up.

bazakeliad commented 3 weeks ago

Created a Wiki document on how to work with Git. @ALL need to review it! See Wiki here - Working-with-Git-as-a-team

Looks good, well done! I think that we should apply protection rules to the project (can't merge without at least 1 approval, can't push directly to main branch, etc).

Added a protection rule to the project (on branch main). The rule enforces the following:

Require a pull request before merging.
Require approvals (At least 1).

BenEpstein commented 2 weeks ago

Finished fixing the Working-with-Git-as-a-team wiki page according to your (@all) review notes discussed in person.

Finished my part of this task 💯

bazakeliad / App-Development-Project

Create a Development Standards Document #4

Overview

DOD

Merge Requests