Skip to content

Files

Latest commit

 

History

History
91 lines (50 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

91 lines (50 loc) · 2.89 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue with us before making a change.

Pull Request Process

In order to contribute, please fork the appropriate branch. Note that if you are writing a new feature, please ensure that you have included the corresponding test case.

We recommend using the Conventional Commits format on commit messages.

Your pull request will be reviewed by a team member as soon as possible once it is submitted.

Development Quick Start

You will need the following:

  • Git

  • React.js

  • Express.js

  • MongoDB

  • CKeditor

     npm install --save @ckeditor/ckeditor5-build-classic
 # Or:
 npm install --save @ckeditor/ckeditor5-build-inline
 # Or:
 npm install --save @ckeditor/ckeditor5-build-balloon
 # Or:
 npm install --save @ckeditor/ckeditor5-build-balloon-block
 # Or:
 npm install --save @ckeditor/ckeditor5-build-decoupled-document

Refer to official websites for detailed instructions.

Team Norms

Team Values

In order to build a positive and efficient developing environment, all team members are required to:

  • Using welcoming and inclusive language

  • Being respectful of differing viewpoints and experiences

  • Gracefully accepting constructive criticism

  • Have confidence that issues discussed will be kept in confidence.

  • Listen to understand.

  • Prioritize collaboration.

Sprint Cadence

One sprint will be two weeks long. Tasks and roles will be announced at the beginning of every sprint.

Daily Standups

Takes place on every Thursday, from 8:00 pm to 9:30 pm. Please note that this meeting is mandatory. If you cannot join the meeting, please notify others in the Slack channel at least one day prior to meeting.

Coding Standards

Naming convention:

  • Meaningful and understandable variables name helps anyone to understand the reason of using it.

  • Local variables should be named using camel case lettering starting with small letter (e.g. localData) whereas Global variables names should start with a capital letter (e.g. GlobalData). Constant names should be formed using capital letters only (e.g. CONSDATA).

  • It is better to avoid the use of digits in variable names.

  • The names of the function should be written in camel case starting with small letters.

  • The name of the function must describe the reason of using the function clearly and briefly.

Indentation:

  • There must be a space after giving a comma between two function arguments.

  • Each nested block should be properly indented and spaced. Proper Indentation should be there at the beginning and at the end of each block in the program.

  • All braces should start from a new line and the code following the end of braces also start from a new line.