Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hoff 113- added Hof skeleton project #1

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Conversation

TemitopeAyokuHO
Copy link
Contributor

@TemitopeAyokuHO TemitopeAyokuHO commented Feb 5, 2024

What?

HOFF-113. create HOF skeleton

Why?

To create a simple and unique template for HOF forms

How?

  • add apps folder and other necessary files

common
hof-project
test

  • add entry page for the app as start.html
  • modify hof.settings.json file to set the route for entry url, specifying the project name , and session id
  • add a readme file for first time users
  • modify the package.json file to add package dependencies, project name and versions and repository url

Testing?

Tested locally

Screenshots (optional)

Anything Else? (optional)

@sulthan-ahmed
Copy link

In terms of your PR, it's good you linked the JIRA ticket.

I would still give a worded What to save the reviewer to go through the ticket. You can just say create HOF skeleton

Dockerfile Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@TemitopeAyokuHO
Copy link
Contributor Author

In terms of your PR, it's good you linked the JIRA ticket.

I would still give a worded What to save the reviewer to go through the ticket. You can just say create HOF skeleton

The Jira ticket is linked to the PR in What section

@sulthan-ahmed
Copy link

Great you've updated it. The link is great it's just it's good to always make it easy for a reviewer to know what the PR is. It's also about people in the future that look back at this PR. They might not be able to access the link in the future

README.md Outdated Show resolved Hide resolved

Step 5: yarn

Step 6: yarn run start:dev

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would highly recommend reading about how to do documentation on github https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github

Whenever you put in codeblocks, the common practice is to use backticks

apps/common/index.js Outdated Show resolved Hide resolved
apps/common/index.js Outdated Show resolved Hide resolved
config.js Outdated Show resolved Hide resolved
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would change

'/confirmation': {
      backLink: false
 }

to

'/confirmation': {
     clearSession: true
}

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have unresolved this as I can't see the change - has it been pushed?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should say clearSession: true

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes push already i have no idea why the changes not coming on

.env Outdated Show resolved Hide resolved
@sulthan-ahmed
Copy link

I agree with @Rhodine-orleans-lindsay the less code/files/modules the better. This also includes content. The main aim of this repo is to build new projects from. Even the readme imho should just tell you how to install and run the app

@Rhodine-orleans-lindsay
Copy link

There is a .DS_Store file in the assets folder that should be ignored by git so you'll need to delete that before you push again

@TemitopeAyokuHO
Copy link
Contributor Author

There is a .DS_Store file in the assets folder that should be ignored by git so you'll need to delete that before you push again

.DS_Store file not found


## Screenshots (optional)

## Anything Else? (optional)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@TemitopeAyokuHO
Copy link
Contributor Author

@Rhodine-orleans-lindsay and @sulthan-ahmed should i squash all the commit messages ?

@sulthan-ahmed
Copy link

You can squash it once it's approved
please follow the chris beams approach of git messages when you do squash it

@sulthan-ahmed
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants