Shortcut React Club

This is the repository of the React learning club of the Shortcut Community in Finland.

Table of Contents

• How to read this repository
• Fork this repository
• How to Contribute

How to read this repository

This repository contains the react projects and assignments that we will create and work on during the live meeting sessions.

master branch

This branch hosts the documentation, reports and projects that we will write or code during the live sessions.

• The documentation includes how to use the repository and the explainations/ressources about different functionalities we learned during the meetings.
• The reports should contain feedback, resources and sumaries of the meetings.
• The projects contains the source code of each project we will code together.

This will be the main branch. Other branches will be used for developping in order to keep the master branch clean.

Fork this repository

If you wish to work on the projects, you are encouraged to Fork this repository.

By forking you will have a copy of the repository with options to synchronize easily as the repository evolves.

You can work on your own forks to do the assignments but you should create a dedicated folder and keep the original folders read only so synchronizing won't cause conflicts. [1]

[1] Prefer editing the original folders if you wish to submit a pull request

How to Contribute

Fork this repository and edit or add new files in the corresponding folders then ask for a Pull Request.

For example:

• If you want to share a nice article, you could write or link some resources in the documentation folder then push to your repository and ask for a Pull Request.

• If you want to improve the code of one project or see a typo; make the changes, push and ask for a Pull Request.

• If you want to add a new bonus or feature to a project, create a folder in projects/[project-name]/[bonus-or-feature-name] and put the code in that folder. Push and ask for a Pull Request.