📔 nnist-pt-20230125 #1

njtalba5127 · 2023-01-25T12:24:52Z

nnist-pt-20230125

Nejilabs NIST Project Template

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 Contents

1- Core Templates

2 - General Templates

Project Notes

Table of Contents

...

njtalba5127 · 2023-01-28T06:47:29Z

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?

njtalba5127 · 2023-01-28T06:50:25Z

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" 😎

njtalba5127 · 2023-01-28T06:57:36Z

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

njtalba5127 · 2023-01-28T07:03:59Z

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)

njtalba5127 · 2023-01-28T07:35:36Z

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.

njtalba5127 · 2023-01-28T07:48:14Z

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.

think this would be a great reminder for the pull requests in my projects 🤔 which would make me double check if im merging to the correct branch, and with the correct branch.

njtalba5127 · 2023-01-28T07:52:45Z

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.

this is another option. cuter reminder. but other one might be better.

njtalba5127 · 2023-01-28T07:55:54Z

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 🤡

njtalba5127 · 2023-01-28T08:03:15Z

oh it be great if all were anime themed ryt? we could also use this but with a caption stating "Did you double check?" 😅

njtalba5127 · 2023-01-28T08:04:52Z

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

njtalba5127 · 2023-01-28T08:32:01Z

for pr templates:

njtalba5127 · 2023-01-28T08:37:44Z

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.

njtalba5127 · 2023-01-28T08:50:44Z

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!

njtalba5127 · 2023-01-28T09:00:20Z

@newojima make feature request & bug issues temps

njtalba5127 · 2023-01-28T12:11:09Z

@newojima make feature request & bug issues temps

done

njtalba5127 · 2023-01-28T12:11:46Z

Yep Lookin Good. I think just the contact links left through our issue templates config.yml @newojima

njtalba5127 · 2023-01-28T12:12:35Z

as for the "componentalised" templates. nah just get them from the samples or barebone templates ^^

njtalba5127 · 2023-01-28T12:21:45Z

https://engineeringfordatascience.com/posts/gitmoji/

ooo this would be cool. adding emojis to commit messages would be really nice.

njtalba5127 · 2023-01-29T13:12:05Z

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

njtalba5127 · 2023-01-29T13:13:31Z

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!

njtalba5127 · 2023-01-29T13:15:28Z

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.

njtalba5127 · 2023-01-30T05:27:44Z

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.

njtalba5127 · 2023-01-30T08:35:48Z

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 -->

njtalba5127 · 2023-01-30T08:51:02Z

maybe improve the layout for this kind of view for our project cover issues

njtalba5127 added the documentation Improvements or additions to documentation label Jan 25, 2023

njtalba5127 self-assigned this Jan 25, 2023

njtalba5127 added this to 💻 NIST | Nejima Institute for Science and Technology Jan 25, 2023

njtalba5127 moved this to Todo in 💻 NIST | Nejima Institute for Science and Technology Jan 25, 2023

njtalba5127 moved this from Todo to In Progress in 💻 NIST | Nejima Institute for Science and Technology Jan 25, 2023

njtalba5127 pinned this issue Jan 25, 2023

njtalba5127 changed the title ~~nejilabs-nist-template~~ nist-pt-20230125 Jan 25, 2023

njtalba5127 changed the title ~~nist-pt-20230125~~ nnist-pt-20230125 Jan 25, 2023

njtalba5127 closed this as completed Jan 25, 2023

github-project-automation bot moved this from In Progress to Done in 💻 NIST | Nejima Institute for Science and Technology Jan 25, 2023

njtalba5127 moved this from Done to Notes in 💻 NIST | Nejima Institute for Science and Technology Jan 25, 2023

njtalba5127 changed the title ~~nnist-pt-20230125~~ 📔 nnist-pt-20230125 Jan 25, 2023

njtalba5127 mentioned this issue Jan 27, 2023

📔 nnist-pt-20230125 Cover Issue (outdated) #4

Closed

3 tasks

njtalba5127 reopened this Jan 27, 2023

This was referenced Jan 28, 2023

📔 Sample: nnist-pt-20230125 Cover Issue #6

Closed

📔 Sample: nnist-pt-20230125 Cover README #9

Closed

njtalba5127 closed this as completed Jan 29, 2023

github-project-automation bot moved this from 📌 Notes to 🥂 Done in 💻 NIST | Nejima Institute for Science and Technology Jan 29, 2023

njtalba5127 reopened this Jan 30, 2023

njtalba5127 moved this from 🥂 Done to 🚧 In Progress in 💻 NIST | Nejima Institute for Science and Technology Jan 30, 2023

📔 nnist-pt-20230125 #1

📔 nnist-pt-20230125 #1

Comments

njtalba5127 commented Jan 25, 2023 • edited Loading

nnist-pt-20230125

Nejilabs NIST Project Template

Project Todos

Project Contents

1- Core Templates

2 - General Templates

Project Notes

...

njtalba5127 commented Jan 28, 2023 • edited Loading

njtalba5127 commented Jan 28, 2023 • edited Loading

njtalba5127 commented Jan 28, 2023 • edited Loading

Main Common Components:

Cover Templates

Chapter Templates

njtalba5127 commented Jan 28, 2023 • edited Loading

Atoms

Molecules

Organisms

Templates (a.k.a. Barebones)

Cover Templates

Chapter Templates

Other Issue Templates

Pull Request Templates

Pages (a.k.a. Samples)

njtalba5127 commented Jan 28, 2023

njtalba5127 commented Jan 28, 2023 • edited Loading

njtalba5127 commented Jan 28, 2023 • edited Loading

njtalba5127 commented Jan 28, 2023 • edited Loading

njtalba5127 commented Jan 28, 2023

njtalba5127 commented Jan 28, 2023 • edited Loading

njtalba5127 commented Jan 28, 2023

njtalba5127 commented Jan 28, 2023 • edited Loading

For Linking Issues in PRs

njtalba5127 commented Jan 28, 2023

Enters: The Wise Guardian Ugandan Knuckles...

1 - Double Check - Triple Check

2 - For Linking Issues in PRs

Have anything to say to dear ol'guardian ugandan knuckles?

For Merging...

Anything else to declare? (Short Description of PR and Affected Issues)

njtalba5127 commented Jan 28, 2023

njtalba5127 commented Jan 28, 2023

njtalba5127 commented Jan 28, 2023

njtalba5127 commented Jan 28, 2023

njtalba5127 commented Jan 28, 2023

njtalba5127 commented Jan 29, 2023 • edited Loading

njtalba5127 commented Jan 29, 2023 • edited Loading

njtalba5127 commented Jan 29, 2023 • edited Loading

njtalba5127 commented Jan 30, 2023

njtalba5127 commented Jan 30, 2023 • edited Loading

njtalba5127 commented Jan 30, 2023

njtalba5127 commented Jan 25, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 28, 2023 •

edited

Loading

njtalba5127 commented Jan 29, 2023 •

edited

Loading

njtalba5127 commented Jan 29, 2023 •

edited

Loading

njtalba5127 commented Jan 29, 2023 •

edited

Loading

njtalba5127 commented Jan 30, 2023 •

edited

Loading