CONTRIBUTING.md

Contributing to Spaces Lounge

Languages

This project is built with Next.js and SASS.

Pre-requisites (these need to be installed on your machine)

Node.js
Yarn Package Manager

How to contribute

1. Fork the project

2. Clone the project:

   git clone https://github.com/<your-github-username>/spaceslounge.git

3. Navigate to the project directory:

   cd spaceslounge

4. Install dependencies:

   yarn

5. Create a new branch:

   git checkout -b <YourBranchName>

6. To run the whole project locally:

   yarn dev

7. Make your changes

8. Stage your changes:

   git add <NameOfFileChanged>

9. Commit your changes:

   git commit -m "<Your commit message here>"

10. Push your commits to your local repository

    git push origin <YourBranchName>

11. Create a pull request

12. Wait for maintainers to review your pull request and suggest any changes

IMPORTANT Naming Conventions

Before pushing your changes, please check and ensure that all your additions follow the naming conventions listed below:

• Folders names should follow the Upper Camel Case convention (FolderName)
• Component file names should follow the Lower Camel Case convention (componentFileName.jsx)
• Components name should follow the Upper Camel Case convention (ComponentName)