Thank you for considering contributing to this project! We welcome any contributions, big or small. Here are some guidelines to help you get started:
If you encounter a bug or have a feature request, please create an issue in the GitHub repository. Be sure to provide a clear and detailed description of the problem, including any steps needed to reproduce it.
If you want to fix an issue or add a new feature, we encourage you to create a pull request (PR).
However, if you're not sure whether your feature is desired or would like some feedback before starting work, feel free to ask in an issue first. Here are the steps to follow:
- Fork the repository and clone it to your local machine.
- Create a new branch for your changes.
- Make your changes and commit them with clear and concise commit messages.
- Push your branch to your forked repository.
- Open a PR to the main repository, with a clear description of the changes you made and why they are valuable.
We will review your PR and provide feedback as needed.
This version of the frontend shouldn't be edited anymore, as it should be replaced by nextJS (see section below).
To set up the project on your local machine, follow these steps:
- Clone the repository to your local machine:
git clone https://github.com/DarkIntaqt/challenges.git- Navigate to the challenges directory:
cd ./challenges- Install the required dependencies:
npm install- Start the project:
npm startCurrently, the frontend is rewritten in nextJs #136. To set up the nextJS branch on your local machine, follow these steps.
- Clone the repository to your local machine:
git clone https://github.com/DarkIntaqt/challenges.git- Navigate to the challenges directory:
cd ./challenges- Change to the nextJS feature branch:
git checkout next- Install the required dependencies:
npm install- Start the project:
npm run dev