Skip to content

Latest commit

 

History

History
180 lines (112 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

180 lines (112 loc) · 4.51 KB
Raw

How to strat contributing to this project

Fork repository

fork repository

Clone forked repository

clone forked repository

Pick up any task on your choise - https://github.com/users/nicitaacom/projects/5

pick up any task on your choise

Create branch name as task name

create branch name as task name

Read CONTRIBUTING.md file and README.md

After you fork this repository and created branch - set up .env using README.md

After you done with .env - read Pull requests and Commit naming

Keep in mind that I reject your PR if you will do all changes in 1 file

That's why do commits as small as possible for this check this video

Create PR

If you done with your changes - jsut go ahead and crete PR

create PR



Pull requests

Pull requests naming

[PR#59]-imp-close_avatar_dropdown_on_item_click In case task related to this PR done you - in [] you write PR and number of this PR

[PR#59-UPD]-imp-close_avatar_dropdown_on_item_click In case task not done every day when you finish coding you do this PR - in [] you write PR and number of this PR and -UPD

Pull requests description

Use descripion template below

Please don't write in 1. Change title 2. Chnage title etc chore / style
Write fix / feat / docs instead

# Changes

### 1. Change

which problem was solved
video/screenshot (preffered)

<br/>

---

<br/>

# Result (n days)

video/screenshot

<br/>

---

<br/>

**Github task** -
This task done - delete this branch and move task to 'Done'
This task not done and created to keep 'development' branch up to date - don't delete this branch


Github projects

Task naming

in case you need to create some task you name this task like below add-close_authModal_button imp-close_avatarDropdown_onClickOutside add-root-open_supportModal_button add-ProductTSX-requestReplanishment_button add-open_supporDropdown_button_UI+logic imp-auth fix-sendEmailToUnauthorizedUser_afterPayment More examples - https://github.com/users/nicitaacom/projects/5/views/1?sortedBy%5Bdirection%5D=desc&sortedBy%5BcolumnId%5D=59471618&pane=issue

  1. Start with add if you need to add smth and imp if you need to improve and fix if you need to fix smth

  2. Add 3-4 snake_case worlds what do you want to add Basicaly on: firstWorld you write logic that object should do e.g close

    secondWorld you write where it should be e.g authModal

    thirdWorld you write object that do something e.g button

    fourthWorld you write condition e.g onCloseOutside

  3. Just check more examples - to get understanding (because for example not always you should write) in which file you need imp or fix smth because it may obvioulsy

Commit naming

style: mb-8 instead of pb-8
chore: AvatarDropdown.tsx incapsulated
chore: ModalContainer renamed to ModalQueryContainer
upd: store for avatarDropdown created
feat: close avatarDropdown on DropdownItem click
docs: commit naming add

  1. chore - for update that doesn't affect on user
  2. style - only styling changes
  3. upd - some minor changes that leads to feat
  4. feat - for some ready feature
  5. docs - for docs changes

Branch naming

Just name your branch as task name e.g imp-close_avatarDropdown_onClickOutside

Updating from development

I use github desktop so I write for this (if you prefer to use terminal do it through teminal)

  1. ctrl+shift+u
  2. click 'Push'
  3. click 'History'
  4. RMB on last commit
  5. Amend commit
  6. Edit commit message to 'Update from 'development'
  7. Click 'Force push origin'


Folder structure

Imports

imports structure

How to undertand what's going on

In each folder I have dev_readme.md file - so you can understnad what's going on in each folder of my project Note: You don't need to read all dev_readme.md files - do it if needed I mean if it not related to your task you may don't read about it

Write your own docs

Wirte docs in style What problem if solves Your docs how to use something

For example: This file needed to format price from 199999.99 to this $1,999,99.99 or I use this component to show how much products will be shown per page I added this component because some users may be annoyed with clicking '>' button