hyperispace/artemareon

Artemis + Ares + eon, symbolizing a long-term mission. Artemis is the goddess of the moon, Ares is the god of war, associated with Mars

Artemareon

Develop

Dependencies need to attention

1. useGSAP
2. @react-three/fiber
3. @react-three/drei, may not be used, but worth to mention since we are talking @react-three/fiber

How to run

npm install
npm run dev

How to collaborate

In this project we use GitHub Flow to collaborate. For branch name, we follow the template your_name/your_branch_name e.g. jinjing.wu/initial-skeleton. For commit message, we follow the Conventional Commits, e.g. feat: initial project skeleton.

1. Create a Branch:

   • Create a new branch for your feature or bug fix. Always start from the main branch:

     git checkout main
     git pull origin main
     git checkout -b your_name/your_branch_name

2. Work on Your Feature:

   • Make your changes on the new branch. Commit your changes frequently with descriptive messages:

     npm run std # this is our custom setup for running lint and prettify our code
     git add .
     git commit -m "feat: Add feature XYZ"

   • Ensure your code is up to date with the main branch by regularly merging the main branch into your feature branch:

     git checkout main
     git pull origin main
     git checkout your_name/your_branch_name
     git merge main

3. Push Your Branch to GitHub:

   • Push your branch to GitHub:

     git push origin your_name/your_branch_name

4. Open a Pull Request (PR):

   • Go to your repository on GitHub.
   • Click on the "Compare & pull request" button that appears after pushing your branch.
   • Fill out the PR form, describing the changes you've made, and submit it.

5. Collaborate and Review:

   • Send your PR to this channel #g8-explore-the-code for requesting reviews from your team members.
   • Address any feedback by making additional commits to your branch. These commits will automatically be added to the open PR.

6. Merge the Pull Request:

   • Once your PR has been reviewed and approved, you can merge it

7. Delete the Branch:

   • After the PR is merged, delete your branch both locally and on GitHub:

     git branch -d your-branch-name
     git push origin --delete your-branch-name

8. Pull Changes into Main:

   • Ensure your local main branch is up to date:

     git checkout main
     git pull origin main

Additional Tips

Sync Often: Regularly pull changes from the main branch into your feature branch to minimize merge conflicts.