-
Notifications
You must be signed in to change notification settings - Fork 0
Git_Note
The projectnext repo is hosted on GitHub. You need to be able to use git to work on projectnext, so learn git.
The main branch is called main. We merge pull requests into main using github, i.e do not merge anything into main locally, you should always create a PR on github. We usually do not rebase, but rather merge our PRs.
The branch called prod (NOT YET IMPLEMENTED) should always contain the code currently in production. This branch has a CD pipeline to our server (NOT IMPLEMENTED) so be extremely careful when merging anything to prod. (VERSIONING ON PROD)
As stated in Getting Started envs and the next-env.d.ts file are gitignored. This is for security reasons and the specifics of environment variables could be sensitive, if you believe that:
- There is a variable that is specific to where projectnext is run, or
- There is a variable with sensitive information.
you should probably considering making it an env. variable. . You can find which environment variables are needed to run the project in default.env and next-env.default.d.ts
We use conventional commits, read about this here, this gives commit messages a good structure and makes it easier to keep track of our history. The verbs: chore, feat, refactor, fix should also be used on branch names but with a / instead of a : used for commits.
Never commit anything directly to main or prod
Projectnext contains three workflows: all of which run when a PR on main is created or when something is pushed to main
- linter
- build
- test read more (NOT IMPLEMENTED)
A PR should never be merged if a test fails!
Footer
Sidebar