Home

Welcome to the Star Wars Quiz wiki!

STACK

• Functional JavaScript
  • Axios
• SCSS
  • BEM
• HTML
• Parcel

INSTALLATION

To install packages, you need to open command line in /CC-PROJECT-2 folder and type&run npm i. It's needed only first time or when something with packages was changed after your last installation.

RUNNING APP

To run app, type&run npm run start:dev in console in the same directory as in installation step. Instead of typing it manually in console you can also run it from NPM SCRIPTS - left bottom corner in VSC.

PULL REQUESTS

Don't commit to develop or main branches. Create an individual branch for every bug/feature. Follow that naming convention:

<type of issue>/<#number of issue><name referring to issue title>

Here is an example:

feature/#12-fetch-function

Create branch from up-to-date develop branch. This can save you from merge conflicts. If your solution is ready, do a merge from develop and resolve eventual conflicts. Remember also to format your code (npm run format). After that push your branch to remote and create a pull request. In every PR should be 2 reviewers, where the second one should be a techlead.

In the description write closes <#number of issue> (in above case it would be ‘closes #12’). It's important also to attach proper project in 'Project' tab. These will automate moving that issue between columns in the project board.

If there is some very small, easy issue where creating new branch would last longer than writing solution, you can do it with some bigger issue, but at least make a separate commit for this. Also include it in PR description.

Instead of writing it in the description you can also use these keywords in the commit message. Click here for more info.

COMPONENTS

Every reusable component should be in separate file (PascalCase) in src/app/components location.

STYLING

Don’t style by tags or ID, use classes instead. Would be great to keep BEM naming convention.

Create separate file (e.g. _'button.scss' - camelCase) in /styles/components folder for every component and import it to the components.scss file.

In _/styles/base/variable.scss should be all variables which are used more than once.

OTHER STUFF

Use // TODO: and // FIXME: to mark places which will need our attention, improvement or implementation if something can't be fixed right away.

Here is quite nice extension to highlight TODOs.