mirror of
https://github.com/placeAtlas/atlas.git
synced 2024-05-18 12:14:38 +02:00
43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
# Contributing
|
|
|
|
This project is open source. You may contribute to the project by submitting a Pull Request on the GitHub repo or send your submissions through Reddit. Other than than, you cau use Discord or Reddit for help.
|
|
|
|
## Map Contributions
|
|
|
|
**WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT!**
|
|
|
|
To contribute to the map, we require a certain format for artwork region and labels. This can be generated on the [contributing page](https://place-atlas.stefanocoding.me/index.html?mode=draw) on the website.
|
|
|
|
### Reddit
|
|
|
|
1. Follow the instructions on the [contributing page](https://place-atlas.stefanocoding.me/index.html?mode=draw), then post it to Reddit by clicking "Post Direct to Reddit".
|
|
2. Flair your post with the "New Entry" tag.
|
|
3. A moderator will accept your contribution shortly.
|
|
|
|
<!--
|
|
|
|
### GitHub
|
|
|
|
1. Create a fork of our repo.
|
|
2. Enter your data into the `web/atlas.json` file, with the correct format and ID number.
|
|
3. Create a Pull Request.
|
|
|
|
-->
|
|
|
|
## Map Edits
|
|
|
|
### Reddit
|
|
|
|
1. Click "Edit" on a entry and follow the instructions there, then post it to Reddit by clicking "Post Direct to Reddit".
|
|
2. Flair your post with the "Edit Entry" tag.
|
|
3. A moderator will accept your contribution shortly.
|
|
|
|
|
|
### GitHub
|
|
|
|
1. Create a fork of our repo.
|
|
2. Enter your data into the `web/atlas.json` file, with the correct format and ID number.
|
|
3. Create a Pull Request against the `cleanup` branch.
|
|
## Cleaning Contributions
|
|
|
|
If you spot a duplicate, please PR against the `cleanup` branch. To help find duplicates, [use the Overlap mode](https://place-atlas.stefanocoding.me?mode=overlap). |