|
|
||
|---|---|---|
| .forgejo/workflows | ||
| doc | ||
| src | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| LICENSE | ||
| README.md | ||
| include_toc |
|---|
| true |
Table of Contents
Welcome
You will find several useful items ehre
Signing commits
Generate an SSH key and add it to your forgejo account and verify it
You dont have to add it to the agent.
Can add it to your forgejo account here
Clone the repo with SSH, can find the SSH link on the repository next to HTTPS
Make sure add your email that commits are made with to your forgejo account at this page .
git config --global gpg.format ssh
git config --global user.signingkey ~/.ssh/id_ed25519
git config --global commit.gpgsign true
git config --global --list
After this try a test commit and push, you should see a green padlock next to the commit history on the forgejo UI.
Grafana Dashboard
Rubric
Final Rubric for teh hackathon.
Deployment by TA is probably the most useful field, if I couldnt deploy it then the Appearance and Functionality was based on memory from the event leading to reduced grades.
Matches Specification ended up being redundant, and the Additional Features was not practical to add either.
Those who used issues/milestones and projects tended to fare better.
| Item | 0 | 1 | 2 | 3 | 4 | 5 (bonus) |
|---|---|---|---|---|---|---|
| Functionality | Non Functional | It works in a demo setup | A fully functional prototype | NA | ||
| Appearance | Un-usable by User | An average user is able to use the tool without much training | Exceptional UI UX | NA | ||
| Structure | Poor layout of the project, files/components | Repo is reasonably organised | Components are well organised | Repo is well structured. Components well organised. Connections to components make sense | NA | |
| Git Usage | Didnt use git at all | Git, gitignore & git-lfs used | Issues/projects/milestones used | CI/CD used | Uses all tools provided exceptionally well (git/issues/projects/milestones/CICD) | Signed Commit messages |
| Deployment by TA | Unable to be deployed | Able to be deployed with difficulty | Able to be deployed | Able to deployed easily | NA | |
| Other Factors |
Unused items
| Item | 1 | 2 | 3 | 4 | 5 | 6 (bonus) |
|---|---|---|---|---|---|---|
| Additional Features | Meet Requirements | Additional Feature that is useful but not described in the spec | Added feature, testing (unit test, ci/cd test, etc) | Very thoughtful and useful Feature, extensive testing, integration testing | ||
| Matches Specification | Does not match specification | Matches Spec | Goes above and beyond the specification | NA |
Next Year
Next year the rubric needs to be expanded to account for:
- Documentation & Deployment
- Will most likely give 24hrs after hackathon to get documentation in order.
- Security
- For a few projects it was possible to bypass login just by knowing the URL's to go to
- More than one group left API keys in teh repo, one on purpose.
- Teamwork
Additionally commit signing documentation in this repo needs to be fleshed out.