Giter Club home page Giter Club logo

coding-guidelines's Introduction

Leapfrog Technology Coding Guidelines

https://coding-guidelines.lftechnology.com

Coding guidelines commonly followed at Leapfrog Technology.

Contributing

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Development

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

coding-guidelines's People

Contributors

anishmanandhar avatar anwesh-b avatar basanta78 avatar binayabaral avatar bipenc avatar dependabot[bot] avatar kabirbaidhya avatar manjillama avatar mesaugat avatar nimesh-mishra avatar nishanbajracharya avatar praneentrendex avatar pratishshr avatar sachit-singh avatar sagarlf avatar sawanvaidya avatar sbimochan avatar shakyaprasen avatar silwalanish avatar thebinitghimire avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

coding-guidelines's Issues

Recommend to use similar relational operator in entire project.

Relational Operators usage recommendation

I recommend using either >= / <= or > / < relationals operators on entire project.

Scenario:

In front end, there are logics like >=256 && <=512 and in other components/files or in backend there is >255 && <511.

Benefits:

No high stress to the human mind. Searching for those ints in entire project will result accurate.

My personal preference is to use >= or <= sign. e.g foo.length >= 1, foo >= 256 && bar <= 512.

Rename the repository to "standards" or "guidelines"

coding-standards-convention is a very verbose name. How about we name the repository to "standards" or "guidelines" and we can add a good description in the readme explaining what it is all about.

We will also have guidelines around git and GitHub and other things which might not come under the "coding" bracket.

Thoughts?

Split sidebar.js per stack/ per topic

Add multiple json objects in sidebar.js, each json object represents sidebar for a specific topic like
python.js javascript.js and add that into sidebar.js, so that sidebar.js looks small and manageable

Turn into PWA.

I think this app should be turned into a progressive app such that it can be run offline.

Also test for apple devices,
Requires apple-mobile-web-app-title meta tags, apple-touch-icon

ValidationError: themeConfig.navbar.links has been renamed as themeConfig.navbar.items error

Hi! I tried to run the project but it seems a validation system was added recently to Docusaurus as an attempt to avoid user configuration errors.

Expected Behaviour

Project to sucessfully run without failure.

Actual Behaviour

Project fails to run with validation error.

ValidationError: themeConfig.navbar.links has been renamed as themeConfig.navbar.items
error 

I've applied a minor patch and sent a pull request fixing the issue.

Step to reproduce

Clone the project and run npm install and then yarn start

Error Screenshot

Screen Shot 2020-08-01 at 8 08 58 PM

P.S. I'm really sorry if you guys don't accept PR from outside the company. I saw an issue and decided to address it.

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.