search

GSG-K3 / code-academy-wiki

GSG code academy Wiki
https://codeacademywiki.herokuapp.com/
1 stars 3 forks source link

Process Guide #1

Open someyaaltous opened 4 years ago

someyaaltous commented 4 years ago

Team: @Rahaf-96 @bayan-404 @kholoudfann @Hussein-shahatet97 Project Lead: @someyaaltous

Issues and Labels

Should be used labels when creating issues.

Time

Time estimation, although hard, its very important. We ask that you try and include a time estimating with Dwyl Labels for every issue, even if you are not sure. There are 5 built-in time labels:

someyaaltous commented 4 years ago

Linting

React Installing

To install the package and its dependencies:

$ npm install --save-dev eslint@4.19.1 \
                         eslint-config-pagarme-react \
                         stylelint@8.0.0 \
                         stylelint-config-pagarme-react \

The peer dependencies specified above have hardcoded versions. If you prefer, you can use the command npm info eslint-config-pagarme-react@latest peerDependencies to find the exact peer dependencies to install.

To include these rules into your project, create the following config files in your root folder:

.eslintrc

{
  "extends": ["pagarme-react"],
  "env": {
    "browser": true
  }
}

.stylelintrc


{
"extends": ["stylelint-config-pagarme-react"]
}
someyaaltous commented 4 years ago

Component definition

All components should always be defined as a directory, named with pascal casing. The main component file should be index.js, main stylesheet style.css like :

HomePage/
├── index.js
└── style.css
someyaaltous commented 4 years ago

Naming Branches

Commit messages

someyaaltous commented 4 years ago

Pull Request Checklist

Merging Pull Requests