diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95359b79..9c49f986 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,35 @@ -# How To Contribute +# Contributing -## Contributing to the Map +This project is open source. You may contribute to the project by submitting a Pull Request on the GitHub repo. -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. +## Map Contributions -You can either post this contribution to the subreddit, or make a Pull Request on the GitHub repo. +

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 Submission -1. Follow the instructions on the [contributing page](/index.html?mode=draw), then click "Post Direct to Reddit". +1. Follow the instructions on the [contributing page](https://place-atlas.stefanocoding.me/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. + -This project is open source. You may contribute to the project by submitting a Pull Request on the GitHub repo. \ No newline at end of file +## Map Edits + +1. Create a fork of our repo. +2. Enter your data into the `web/_js/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 `/cleanup`. To help find duplicates, run the code locally, changing line 92 of `main.js` to `overlap`. \ No newline at end of file diff --git a/README.md b/README.md index de2465a9..0ae68bc0 100644 --- a/README.md +++ b/README.md @@ -6,28 +6,38 @@ This project was created by Roland Rytz and is licensed under the GNU Affero Gen *You can check out the website by clicking [here](https://place-atlas.stefanocoding.me/).* -To submit new entries or request changes to existing ones, please visit [/r/placeAtlas2](https://www.reddit.com/r/placeAtlas2/). +If you don't know GitHub and wanted to submit new entries or request changes to existing ones, please visit [/r/placeAtlas2](https://www.reddit.com/r/placeAtlas2/). -# How To Contribute +## How To Contribute -## Map Contributions +### Map Contributions -### WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT +

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 Submission +#### Reddit Submission 1. Follow the instructions on the [contributing page](https://place-atlas.stefanocoding.me/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. -## Map Edits + + +### Map Edits 1. Create a fork of our repo. 2. Enter your data into the `web/_js/atlas.json` file, with the correct format and ID number. 3. Create a Pull Request against the `/cleanup` branch. -## Cleaning Contributions +### Cleaning Contributions If you spot a duplicate, please PR against `/cleanup`. To help find duplicates, run the code locally, changing line 92 of `main.js` to `overlap`.