Skip to content

Latest commit

 

History

History
118 lines (94 loc) · 5.18 KB

README.md

File metadata and controls

118 lines (94 loc) · 5.18 KB
Raw

ZenSite 2021

Reimagining Zenith's web presence through a modern website that respects the group's technical knowledge and passion for development. We're a student group based in Brazil, we develop open software and hardware. #AdAstraPerAspera

Environment and Tools • Steps to run and debug • How to contribute?

Environment and tools

We're using ESLint and Prettier for linting/formatting.

Steps to run and debug

  • (recommended) npm run dev to compile it in development mode and run it on localhost:3000.
  • npm run build to create an optimized production build
  • npm start to run the production build on localhost

How to contribute

Check out our figma.

Report bugs and/or feature-requests on our issue tab. Maybe there's something there waiting for you to work on!

Gitflow Holy Rules

  • Never commit directly into the Production branch;
  • Always run git fetch && git status, especially before merging (also run it on the branch you're trying to merge to) or pushing (I always run it every 5 minutes or so);
  • Create a branch to work on;
  • Name your branches according to their function. ex: "feature/feature-name"
  • Before merging into Develop, TEST your implementation (is it responsive?);

Naming conventions

  • Variables: camelCase;
  • Functions: camelCase;
  • Classes: PascalCase;
  • Archives: PascalCase;
  • Folders: kebab-case;

Linting and formatting

We're using ESLint and Prettier for linting/formatting.

Specific details can be found on .eslintrc.json and .pretierrc.js

zenith.eesc@gmail.com