CONTRIBUTING

# Contribution guidelines
---

Thank you for taking the time to contribute to the Anweddol project!

In this guide you will retrieve the contribution guidelines.

## Getting started

In order to be able to bring new ideas and enhancements with ease, you can read the [Developer section]() and the [Technical specifications]() of the Anweddol client and server to know how it works.

## Issues

### Create an issue

If you encounter a problem with the software, be it a bug or a potential error in the code or the docs, search for another issue of its kind first to prevent duplicates. If you find one, you can comment on it to give more importance to the issue.

### Solve / contribute to an issue

You can scroll through the issues and find one that interests you. There is no assignee for issues : Everyone is free to contribute to it.

## Make changes

### Pull requests

Any changes will result in a new pull request, which will be reviewed before merging.

### Documentation

If your modification proposition involves a modification of the core features or of an already documented one, you need to provide the appropriate documentation as well.

### Code map

At the root of the project is a file called `CODEMAP.md` : It is a file showing the overall source code file / folders structure, explaining their respective contents and purpose.

This file was made to facilitate contributions by providing a map of the source code.