📔 nnist-pt-20230125
Opened this issue · 24 comments
Description: Nejilabs NIST Project Template used to generate NIST projects along with a standardised design for README.md notes, issues and pull request templates.
In the long term, after we further develop and perfected this project template in Nejilabs, we then move thi project template repo to https://github.com/nejima-kaihatsu (parent).
We then develop that repo to be known as the "Universal Project Template", where it shall dictate the standards and stuff of what projects under the Nejima Group should have (issue & pr templates, common actions and workflows, etc.).
The Universal Project template shall then be shared / forked to its subsidiaries to generate their projects from, while adapting to the branding specs of each according subsidiary.
Project Todos
Project Notes
Table of Contents
......
dont u think it would be better to componentalise these templates? maybe by following atomic design principle where we divide them to smaller reusable components -> atoms, molecules, organisms like that?
well, sure. lets have those too and see how we behave, if we prefer a prebuilt barebones template, interchangeble sample template, or building it our own way using smaller templated components. but as much as possible we want uniformity and standardisation "in style-by style" 😎
Main Common Components:
Cover Templates
- Top Buttons
- Link Button to the course / article / repo.
- Link Button to the author / creator / channel / etc.
- Date of Creation
- Status + Timestamp
- Thumbnail
- Name
- name we named the project repo
- their real name (ex: full title of course video / article)
- Description
Interchangeables:
- if cover issue: content section
- task format
- if cover readme: notes section
- table of contents
- section for the notes
Chapter Templates
- if chapter issue: just the timestamp and preset attributes
- if chapter readme: just dump to the main readme's notes section for easy generation of table of contents
oh my head
Atoms
List of Atoms
-
Main Link Badge button
-
Main Channel Link Badge Button
-
Date of Creation Badge
-
Status Badge
-
Timestamp Badge
-
Thumbnail
-
Project Repo Name
-
Project Full / Real Name
-
Description toggle
-
Table of Contents toggle
-
Notes Section
-
Contents Section
Molecules
Organisms
Project Information
Project Contents
Project Notes
Templates (a.k.a. Barebones)
Cover Templates
- Cover Issue
- Cover README
Chapter Templates
- Chapter Issue
Chapter README
Other Issue Templates
...
Pull Request Templates
...
Pages (a.k.a. Samples)
i think for the pull request template. i would like a reminder to check if im merging to the correct branch, and / or also with the correct branch.
i think for the pull request template. i would like a reminder to check if im merging to the correct branch, and / or also with the correct branch.
i think for the pull request template. i would like a reminder to check if im merging to the correct branch, and / or also with the correct branch.
we can implement instead an action for every creation of pull request as its dispatcher. but tbh normally i dont add anything in prs, and it seems empty.
i think having em as templates would be faster cuz the action might take longer since it still gets dispatched and needs to run, while having them directly on templates would be rather instant.
it would be like having a communication with github, treatin em like a friend u know who watchin yo back 😅 ?
nah we just lonely 🤡
honestly if we implement a github action pr checker, we could have these options randomised - more dynamic and fun. but were just starting out. lets stick with the first one for now. make this a future project instead.
we made a project like this before also. https://github.com/nejilabs/colbyfayock-cgaingajt-20210205
For Linking Issues in PRs
| Linked issue | Syntax on PR's Description | Example |
|---|---|---|
| Issue in the same repository | KEYWORD #ISSUE-NUMBER | Closes #10 |
| Issue in a different repository | KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER | Fixes octo-org/octo-repo#100 |
| Multiple issues | Use full syntax for each issue | Resolves #10, resolves #123, resolves octo-org/octo-repo#100 |
otherwise u can manually link them after.
this is the pr temp i came up with 🤣 :
Guardian Ugandan Knuckles
Enters: The Wise Guardian Ugandan Knuckles...
1 - Double Check - Triple Check
Check if you are merging to the correct branch. And with the Correct Branch pls. 🙏
2 - For Linking Issues in PRs
| Linked issue | Syntax on PR's Description | Example |
|---|---|---|
| Issue in the same repository | KEYWORD #ISSUE-NUMBER | Closes #10 |
| Issue in a different repository | KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER | Fixes octo-org/octo-repo#100 |
| Multiple issues | Use full syntax for each issue | Resolves #10, resolves #123, resolves octo-org/octo-repo#100 |
otherwise u can manually link them after. 👍
Have anything to say to dear ol'guardian ugandan knuckles?
For Merging...
- Double-checked?
- Triple-checked?
Anything else to declare? (Short Description of PR and Affected Issues)
- Thx Knuckles!
@newojima make feature request & bug issues temps
@newojima make feature request & bug issues temps
done
Yep Lookin Good. I think just the contact links left through our issue templates config.yml @newojima
as for the "componentalised" templates. nah just get them from the samples or barebone templates ^^
https://engineeringfordatascience.com/posts/gitmoji/
ooo this would be cool. adding emojis to commit messages would be really nice.
ok so cuz in the future once we perfected the design of this for project template with nejilab's research projects, well transfer this repo or perhaps create a new one based on this to nejima-kaihatsu (https://github.com/nejima-kaihatsu) where we will establish that repo as the "universal project template" which is forked to its subsidiaries and suited with their according branding for their own projects. the forks then will get the master branch version of the universal project template whenever theres gonna be a massive change to the standard design for all our projects shared among all of us. thus called "universal"
so did these tests:
-
tried to fork this and if it is possible to generate a project from a forked project template
https://github.com/nejilabs/nnist-fptt-20230129
it has the sync fork to sync with where it was forked from however no issues tab :/. but thats not that bad actually. -
tried to generate a project from the forked project template and it was a success. this time it was like a normal repo that was generated from a normal project template. which fits our expectations and requirements, hence a success and it has been determined it was truly possible given the kind of system we want to implement in the future for the long run.
https://github.com/nejilabs/nnist-gpffptt-20230129
perhaps in the future we can implement github actions useful for our projects. but thats in the future. for now, we call this a major success for a brighter future!
actually i think its best we create a new repo to @nejima-kaihatsu instead of transferring this repo there and change it accordingly. for documentation purposes? afterall this is counted as a research project for experiment.
dont u think itll be better to just merge the cover issue and cover readme template designs. then by default well just comment out the notes section. cuz usually we compile the notes at the end of the project, while we take the quick dirty notes using the github issues along the project cover tracker issue.
implemented new colors and varying emojis for project status:
<!-- Start: Status | Color Palette Source: https://www.astrouxds.com/img/patterns/status-system-fundamentals.png
✨TODO - 2dccff,
🚧ONGOING - ffb302
✔️DONE - 56f000
⏳STANDBY - 964B00,
❌CANCELLED - ff3838,
💀FAILED - 9ea7ad
-->
<img src="https://img.shields.io/badge/.-9ea7ad?style=for-the-badge"><img src="https://img.shields.io/badge/💀FAILED -333333?style=for-the-badge">
<!-- End: Status -->
maybe improve the layout for this kind of view for our project cover issues