Welcome to CineSimile, an open source platform to find similar movies. If you want to contribute to this project you can follow the following steps.
- Fork and Clone the repository
- Select an issue and work on that issue
- Create a Pull Request
- That's it
Contributing to CineSimile is simple. CineSimile is developed using ReactJS and IBM Carbon Design System. The following are the pre-requisites to contributing.
- Knowledge of basic ReactJS
- Components and modular architecture of a React application.
Don't get intimidated by above line. It means that you have to create seperate components in React and use those in other places. We all know this, but we are not quite familiar with the terminology 😁. This is a good place to get to know about React Architecture and best practices.
- Basic knowledge in IBM Carbon Design System
This is not exactly necessary. If you just know how to build a component in HTML, that's all you need to know. However, IBM Carbon Design System is wonderful, it is worth learning. The following resources will be useful if you want to learn about it.
- https://www.carbondesignsystem.com/developing/react-tutorial/overview/
- https://www.carbondesignsystem.com/developing/get-started/
- https://github.com/carbon-design-system/carbon-tutorial/
- https://react.carbondesignsystem.com/
We are using the following component structure.
project_root
│ README.md
│ CODE_OF_CONDUCT.md
| CONTRIBUTING.md
| LICENSE
| package.json
│
└───src
│ │ App.js
│ │ routes.js
| | index.js
│ │
│ └───actions
| └───helpers
| └───components
| |
| └───Header
| | | index.js
| |
| └───Home
| | index.js
│
└───node_modules/
|
└───public/
When contributing, you can create new React components inside /src/components/<COMPONENT_NAME>/index.js. It supports the core architecture of React and the modularity of our application.
Fret not my dear friends. We are here to help you. If you have any issue with the development or you need some advice, please feel free to open an issue and we will attend to it in no time. 😇