MirrorHub/atlas
0
0
Fork 0
mirror of https://github.com/placeAtlas/atlas.git synced 2024-10-15 05:49:12 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #346 from Codixer/feature/contributing

Browse source 
Feature/contributing
This commit is contained in:
Aeywoo 2022-04-05 23:00:02 +09:30 committed by GitHub
commit fc0f4c5bb5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -7,3 +7,27 @@ This project was created by Roland Rytz and is licensed under the GNU Affero Gen
*You can check out the website at by clicking [here](https://place-atlas.stefanocoding.me/).*
To submit new entries or request changes to existing ones, please visist [/r/placeAtlas2](https://www.reddit.com/r/placeAtlas2/).
# How To Contribute
## Map Contributions
To contribute to the map, we require a certain format for artwork region and labels. This can be generated on the [contributing page](/index.html?mode=draw) on the website.
You can either post this contribution to the subreddit, or make a Pull Request on the GitHub repo.
### Reddit Submission
1. Follow the instructions on the [contributing page](/index.html?mode=draw), then click "Post Direct to Reddit".
2. Flair your post with the "New Entry" tag.
3. A moderator will accept your contribution shortly.
### GitHub Submission
1. Create a fork of our repo.
2. Enter your data into the `web/_js/atlas.js` file, with the correct format and ID number.
3. Create a Pull Request.
## Cleaning Contributions
If you spot a duplicate, please PR against `/cleaning`. To help find duplicates, run the code locally, changing line 92 of `main.js` to `overlap`.