fviazzi / react-redux-base Goto Github PK

Simplest base setup for a react redux project.

• Getting Started
• Git Guidelines

• Run npm or yarn install command:

npm install

yarn install

• Run build command:

npm start

At this point, you will get a [Browsersync] message with Access URLs:. You can use the local url for desktop development or the external URL on any device contected to the same network.

We use two main branches: master and dev.

Master branch is a mirror of production. The only person allowed to merge into master is the project administrator.

Dev is the main branch used for development. This is where all the team’s work meet before merging into master, so everything here must be production-ready before merging into master.

You can use dev branch to develop and push your work there. Alternatively, using a personal branch is advised, especially if you are working on a patch or a feature outside the current sprint.

Normally, a single line commit is fine, but if you need a body for your commit message, separate the body from the subject with a blank line

• The first line is treated as the subject of the commit and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); various tools like log, shortlog and rebase can get confused if you run the two together.

Example:

[TITLE] Aim for 50 characters limit in your commit message subject. 72 is the hard limit.

[BODY] More detailed explanatory text, if necessary. Wrap it to about 72 characters or so.

Explain the problem that this commit is solving. Focus on why you are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this change? Here's the place to explain them.

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded by a single space, with blank lines in between, but conventions vary here

• Start your commit message capitalized

$ Awesome commit message

• Do not end the subject line with a period

• Use the imperative mood in the subject line:

  Imperative mood just means “spoken or written as if giving a command or instruction”

   $ Fix function x causing bug x

   $ Add feature x for to do function x

  This sentence can help you get the indicative mood:

  If applied, this commit will your subject line here

  For example:

   ✓ If applied, this commit will Fix SomeFunc function causing load crash
  
   ✗ If applied, this commit will Fixed SomeFunc function causing load crash