/SKE19-Project-Archive

An archive to contain all students' projects of Secret Order or potentially others.

SKE Project Collection

A curated list of projects collected from the members of Secret Order that uploaded their project to Github.

The project directory is split into an order of, Year > Semester

Each of the Semester folders has a README.md file contained to include the list of projects along with their respective authors.

Adding Your Project

⚠ IMPORTANT ⚠

  • Fork this repository and enable Github Actions (This is required, if the PR doesn't come with checks or marks the PR will be rejected.) DO THIS BEFORE CONTINUING!!!

⚠ IMPORTANT ⚠

  • Clone it onto your machine. Do not work on the main repo!
> git clone <your_fork_repo> ske-projs
> cd ske-projs
  • You may or not, make a new branch for your contribution. (Optional)
ske-projs/ > git checkout -B <your_new_branch>
  • Navigate to the respective folders and contribute a new submodule there, do note that when adding submodules you should use HTTPS links ending with .git.

For example if your project is in year 1 semester 1,

ske-projs/ > git submodule add <your_project_repo_on_github> year1/semester1/<repo_name>

or if your project is in year 3 semester 2,

ske-projs/ > git submodule add <your_project_repo_on_github> year3/semester2/<repo_name>
  • Edit the README.md file in that folder to include your project name and the author(s) of that project.
  • Finally, make a commit then make a pull request.
> git add .
> git commit -m "added project by <your_name> to Year 1 Semester 1"

Guidelines on PR Submission

  • A pull request will need to come from a member of the organization, any other exterior individuals' PRs are ignored and rejected.
  • A pull request should include a new submodule linked to a project repository and changes to the README.md files in respective folders.
  • A pull request should be a single commit with a message of whom the project was added and its respective year and semester for example,
> git commit -m "added project by <your_name> to Year 1 Semester 1"

Enabling Github Actions

Go to your fork, then Actions tab and the click on the green button with text, "I understand my workflows, go ahead and enable them"