Choose an issue
To get started, please feel free to start working on any issues we have created and that are not assigned to anyone yet. If you would like to pick up an issue, please leave a comment for the other contributors to see that this issue is already be worked on.
For starters, we recommend to pick up issues labelled good first issue.
Get setup
- Fork the repository
- Clone your forked repository onto your local machine
- inside your CLI (Command Line Interface), move into your working directory
- run `npm ci` inside the root, client *and* server folder to install all dependencies needed for this project
- inside the client folder, run `npm run dev` to start the development server
Create a branch for your feature
Below you can find an overview of the branches we are using.
- master (protected) - dev (protected) - documentation - feature -- feature/FEATURE-NAME --- feature/#<Issue Number>_<little feature title> --- feature/#<Issue Number>_<little feature title> --- feature/#<Issue Number>_<little feature title> - bugfix (fixing issues that are not urgent) - hotfix (fixing issues that need to be merged ASAP)An example for a ToDo list feature could look as following:
-- feature/#1_todo-listAdd your code
Create a Pull Request
For consistency and easier readability, we would like to ask everyone to use the templates for Pull Requests and Issues that we provide. They follow this pattern:
<subject> (A title to summarise what this is about) <body> (A detailed description of your PR, feature idea or issue) Resolves #ISSUE_NUMBERNote: It is important to add the #number for the issue the PR is resolving in order to close the issue accordingly once the PR getsmerged. You can read more about this here