| | 1 | + | # How to contribute |
| | 2 | + | |
| | 3 | + | Hey! I'm really glad you're reading this. Maigret contains a lot of sites, and it is very hard to keep all the sites operational. That's why any fix is important. |
| | 4 | + | |
| | 5 | + | ## How to add a new site |
| | 6 | + | |
| | 7 | + | #### Beginner level |
| | 8 | + | |
| | 9 | + | You can use Maigret **submit mode** (`maigret --submit URL`) to add a new site or update an existing site. In this mode Maigret do an automatic analysis of the given account URL or site main page URL to determine the site engine and methods to check account presence. After checking Maigret asks if you want to add the site, answering y/Y will rewrite the local database. |
| | 10 | + | |
| | 11 | + | #### Advanced level |
| | 12 | + | |
| | 13 | + | You can edit [the database JSON file](https://github.com/soxoj/maigret/blob/main/maigret/resources/data.json) (`./maigret/resources/data.json`) manually. |
| | 14 | + | |
| | 15 | + | ## Testing |
| | 16 | + | |
| | 17 | + | There are CI checks for every PR to the Maigret repository. But it will be better to run `make format`, `make link` and `make test` to ensure you've made a corrent changes. |
| | 18 | + | |
| | 19 | + | ## Submitting changes |
| | 20 | + | |
| | 21 | + | To submit you changes you must [send a GitHub PR](https://github.com/soxoj/maigret/pulls) to the Maigret project. |
| | 22 | + | Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this: |
| | 23 | + | |
| | 24 | + | $ git commit -m "A brief summary of the commit |
| | 25 | + | > |
| | 26 | + | > A paragraph describing what changed and its impact." |
| | 27 | + | |
| | 28 | + | ## Coding conventions |
| | 29 | + | |
| | 30 | + | Start reading the code and you'll get the hang of it. ;) |
| | 31 | + | |
