MirrorHub/atlas
0
0
Fork 0
mirror of https://github.com/placeAtlas/atlas.git synced 2024-12-26 08:04:04 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #437 from Hans5958/readme

Browse source 
README and CONTRIBUTING changes
This commit is contained in:
ash 2022-04-05 16:50:37 +01:00 committed by GitHub
commit c12f8b004c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md
View file

@ -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.
<h3><b>WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT</b></h3>
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.
<!--
### 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.
## Contributing to the Project
-->
This project is open source. You may contribute to the project by submitting a Pull Request on the GitHub repo.
## 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`.

24
README.md
View file

@ -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
<h4><b>WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT</b></h4>
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
<!--
#### 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.
-->
### 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`.