Skip to content

Latest commit

 

History

History
124 lines (101 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

124 lines (101 loc) · 3.7 KB

RCMS Workflow

To contribute, please follow the workflow below. Only push directly to the master branch if you know exactly what you're doing. Evaluate the impact of change before doing so.

  1. Make sure your local master is up-to-date.

    git checkout master
git pull origin master

  2. Create a new local branch from your master branch to work on your changes.

    git checkout -b <my-feature-branch>

  3. Make changes on your new branch. Add. Commit. Repeat.

    git add .
git commit -m "A meaningful commit message"

  4. When you are ready to push your branch, make sure it's up-to-date with the remote master first.

    git checkout master
git pull origin master
git checkout <my-feature-branch>
git rebase master

  5. Resolve conflicts if there's any using the IDE's tool. https://www.jetbrains.com/help/idea/resolving-conflicts.html

  6. Make sure there's no more conflict and you're now ready to push your changes to the remote repository.

    git push origin <my-feature-branch>

  7. Open a merge request on github to merge your branch to master. https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request

PHP Styles

  • Common File Structure

    <?php

// this block is not needed if there's no pre-processing needed
// request validation, connect to database
// data processing/retrieval

?>

<?php include '../src/templates/header.php' ?>
<?php include '../src/templates/navbar.php' ?>


<!-- html codes here... -->


<?php include '../src/templates/footer.php' ?>

  • Use PHP short echo tags <?= ?>

    <title><?= $title; ?></title>

// Instead of ...

<title><?php echo $title; ?></title>

  • Use alternative syntax for control structure

    <?php if ($signed_in) : ?>
    <!-- html codes to show if user is signed in... -->
<?php else : ?>
    <!-- html codes to show if user is NOT signed in... -->
<?php endif; ?>


<?php foreach($datas as $data): ?>
    <!-- html codes to be repeatedly used -->
<?php endforeach; ?>

  • DO NOT ECHO BLOCKS OF HTML

Database Naming Rules

  • Only use lowercase letters and underscores for all names (table, key, field names).
  • Do NOT use camel case.
  • use underscores to replace space if needed.
  • use only "id" with type integer, autoincrement for primary key of a table, strictly no "user_id" or "student_id".
  • "user_id" or "student_id" only for foreign key.

Project Folder Structure

The folder structure for this project:

root/
├── config/             # configuration files
│   └── config.php
├── mysql/              # database files
│   └── setup.sql
├── public/             # web root
│   ├── assets/
│   │   ├── css/
│   │   ├── img/
│   │   └── js/
│   ├── .htaccess
│   └── index.php
├── src/                # PHP source codes
│   ├── api/            
│   ├── models/ 
│   ├── modules/ 
│   ├── templates/ 
│   └── utilities/ 
├── uploads/            # user private uploads (gitignored)
├── tests/              # test files
├── vendor/
├── .gitignore
├── composer.json
└── README.md

References: