Code Monkey home page Code Monkey logo

members-site's Introduction

Better Uptime Badge

website-members

The part of the website that shows the members of RDS This page is hosted on: https://members.realdevsquad.com/

How can I contribute?

You can find a detailed guide here!

Setup and running locally

  1. Run yarn dev
  2. Visit dev website: https://dev.realdevsquad.com

Coding Conventions

There are only 2 things in computer science: cache invalidation & naming things โ€” *****Phil Karlton*****

Imports Order

  • External Libraries
  • Internal Libraries
  • Components
  • Types
  • Images
  • CSS

Commits style:

  • Make Atomic commits of changes, even if they are across multiple files in logical units.
    • Add displayName to make the Header clear
    • Remove unused date format
    • Chore change library version
  • It's alright to add a Description even if it's big we want to understand things just by reading the commit description at times.

Branch Naming:

  • Follow a simple Convention
feat: creating new features
mod: modifying existing feature
opti: for optimization existing flow
hotfix: you know what it means
poc: for proof of concept
refact: for  cleanup and refactor

Naming convention:

  • the names shall be short & self descriptive

example

/*BAD*/
const value = 5; //what is this value ?
const isPagination = true; // what does it do ?

/*GOOD*/
const initialIndexValue = 5;
const isPaginationEnabled = true;

Sanity:

  • avoid & follow
//bad
const onItmClk = () => {};

//good
const onItemClick = () => {};

const onProceedBtnClick = () => {};

Folder structure:

  • Files that are used in another specific file name them using the following convention
  • avatar.types.ts, avatar.constants.ts, specific components used in parent component inside the same folder itself
  • example folder structuring https://www.joshwcomeau.com/react/file-structure/

PR:

  • Description
  • files changed: local or package?
  • Screenshots
  • Dev sanity

members-site's People

Contributors

vinayak-trivedi avatar anishpawaskar avatar vvaibhavdesai avatar sahsisunny avatar samyakshah3008 avatar archit7448 avatar vinayakahegade avatar ajoykumardas12 avatar iamitprakash avatar nabajits avatar satyam73 avatar yesyash avatar ivinayakg avatar kotesh-arya avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.