mirror of
https://github.com/placeAtlas/atlas.git
synced 2024-05-17 19:54:02 +02:00
Improve Contributing
Redirect to CONTRIBUTING.md to collect it into a single place. Use CONTRIBUTING.md instead of linking the Reddit post
This commit is contained in:
Hans5958
parent
ef53394fb7
commit
8e73eeb1c5
113
CONTRIBUTING.md
113
CONTRIBUTING.md
|
|
@ -1,43 +1,108 @@
|
|||
# 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.
|
||||
This project is open source, and contributions are welcome. In fact, the Atlas relies on user contributions.
|
||||
|
||||
## Map Contributions
|
||||
You may contribute to the project by submitting a Pull Request on the GitHub repo or sending your submissions through [Reddit](https://www.reddit.com/r/placeAtlas2). Other than than, you cau use [Discord](https://discord.gg/pJkm23b2nA) or [Reddit](https://www.reddit.com/r/placeAtlas2) for help.
|
||||
|
||||
**WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT!**
|
||||
## New Atlas Entries
|
||||
|
||||
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.
|
||||
> **Warning**: **WE ONLY ACCEPT NEW ENTRIES 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?mode=draw) on the website.
|
||||
|
||||
To add a new entry, go to [the contributing link](https://place-atlas.stefanocoding.me?mode=draw) and draw a shape/polygon around the region you'd like to describe. You can use the <kbd>Undo</kbd>, <kbd>Redo</kbd>, and <kbd>Reset</kbd> buttons to help you creating a good polygon. Make sure that the lines you're drawing don't form a [self-intersecting polygon](https://upload.wikimedia.org/wikipedia/commons/thumb/0/0f/Complex_polygon.svg/288px-Complex_polygon.svg.png).
|
||||
|
||||
Multiple periods can be added to represent the changing state of the artwork on different times. You can set the start and end period, as well as chosing the appropriate canvas variations. You can also copy the polygon from one period to the other, duplicating a period to be edited later, as well as deleting a period (if there is more than one). An alert is also shown if there are errors for assistance.
|
||||
|
||||
When you're happy with the shape you've drawn, press <kbd>Finish</kbd>. You will now be able to enter some information about the highlighted region:
|
||||
|
||||
- Name: A short, descriptive name.
|
||||
- Description: A short description that will also be understood by somebody not familiar with the topic. Usually, the first sentence on Wikipedia is a good example.
|
||||
- Website: If you're describing a project, the project's main website would be suitable here.
|
||||
- Subreddit: The subreddit that's either most relevant to the topic, or that was responsible for creating the artwork. Format it like `r/subreddit`.
|
||||
- Discord: The invite code to the Discord server that's either most relevant to the topic, or that was responsible for creating the artwork. Write the invite code, that the invite link without the `discord.gg/` part.
|
||||
- Wiki: The page title of [The r/place Wiki](https://place-wiki.stefanocoding.me/) that's related to the artwork.
|
||||
|
||||
All fields but the name are optional. A country flag doesn't necessarily need a description, for example.
|
||||
|
||||
Once you've entered all the information, you'll be presented with a pop-up window containing some [JSON](https://en.wikipedia.org/wiki/JSON)-formatted data. You can press the <kbd>Press Direct to Reddit</kbd> button, or copy the entire JSON text and [create a new text post on the subreddit](https://www.reddit.com/r/placeAtlas2/submit). Remember to flair your post with "New Entry".
|
||||
|
||||
## Edits To Atlas Data
|
||||
|
||||
Other than adding new ones, you can edit existing atlas entries.
|
||||
|
||||
### 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.
|
||||
|
||||
<!--
|
||||
You can use the website to edit single entries easily. On the website, click <kbd>Edit</kbd> on an entry box. Afterwards, you can follow the same instructions as [when creating a new entry](#new-atlas-entries). Upon submitting, please label it as "Edit Entry" instead.
|
||||
|
||||
### 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.
|
||||
Edits are also welcome on this repository through GitHub. You may use GitHub for bulk or large-scale changes, such as removing duplicates.
|
||||
|
||||
-->
|
||||
`web/atlas.json` is where the atlas data is located, in which you can edit on GitHub. Below is an example of an entry. The example has been expanded, but please save it in the way so each line is an entry which is minified.
|
||||
|
||||
## Map Edits
|
||||
```json5
|
||||
{
|
||||
"id": "tu203o",
|
||||
"name": "An entry",
|
||||
"description": "This is an entry, it is remarkable.",
|
||||
"links": {
|
||||
"subreddit": ["placeAtlas2", "subreddit1", "subreddit2"],
|
||||
"discord": ["pJkm23b2nA"],
|
||||
"website": ["https://example.com"],
|
||||
"wiki": ["An_Entry", "An_Entry_2"]
|
||||
},
|
||||
"path": {
|
||||
// 109-166: Default canvas variation (r/place), period 109 to 166.
|
||||
// T:0-1: "The Final Clean" canvas variation, period 0 (The Final Clean) to 1 (Unofficial Corrections).
|
||||
"109-166, T:0-1": [
|
||||
[1527, 1712],
|
||||
[1625, 1712],
|
||||
[1625, 1682],
|
||||
// ...
|
||||
]
|
||||
},
|
||||
"center": {
|
||||
"109-166, T:0-1": [1639, 1754]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Reddit
|
||||
Upon creating a fork of this repository and pushing the changes, create a Pull Request against the `cleanup` branch. A member will merge the pull request if it is adequate.
|
||||
|
||||
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.
|
||||
To help find duplicates, [use the Overlap mode](https://place-atlas.stefanocoding.me?mode=overlap).
|
||||
|
||||
## Development
|
||||
|
||||
### GitHub
|
||||
Other than contributing to the atlas data, code contributions are also accepted. Here are some information regarding some aspects on the repository.
|
||||
|
||||
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
|
||||
### Web interface
|
||||
|
||||
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).
|
||||
This website is built using classic HTML 5 (no JS frameworks such as Vue, React, etc are used). Bootstrap 5 is used as a CSS framework.
|
||||
|
||||
Opening the HTML file on your browser is adequate enough to edit. If it doesn't work, you can try running a local HTTP server.
|
||||
|
||||
```sh
|
||||
# Run it inside the web/ folder.
|
||||
cd web
|
||||
|
||||
# Choose one of the following.
|
||||
# Python 2
|
||||
python -m SimpleHTTPServer 8000
|
||||
# Python 3
|
||||
python -m http.server 8000
|
||||
# Node.js (http-server)
|
||||
npx http-server
|
||||
# Node.js (serve)
|
||||
npx serve
|
||||
```
|
||||
|
||||
### Tools
|
||||
|
||||
The `tools` folder have various scripts for the maintainance of the project, such as...
|
||||
|
||||
- Adding submitted entries from the subreddit
|
||||
- Formatting/tidying up the data
|
||||
- Building the site for production
|
||||
|
||||
The tools are built using either Node.js and/or Python (3).
|
||||
|
|
@ -20,7 +20,11 @@ If you don't know GitHub and wanted to submit new entries or request changes to
|
|||
|
||||
## 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.
|
||||
This project is open source, and contributions are welcome. In fact, the Atlas relies on user contributions.
|
||||
|
||||
Please read [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to submit a new entry, edit existing entries, or contribute to the development of the codebase.
|
||||
|
||||
[The r/placeAlas2 subreddit](https://reddit.com/r/placeAtlas2/) and [the Discord server](https://discord.gg/pJkm23b2nA) is also the place to submit all bug reports, feature requests, or questions.
|
||||
|
||||
## Contributors
|
||||
|
||||
|
|
|
|||
|
|
@ -88,9 +88,9 @@ <h1 class="display-5 fw-bold mb-4">The 2022 r/place Atlas</h1>
|
|||
<p>Roland Rytz worked on the Atlas full-time (and more!) for over two weeks during the 2017 r/place event. If you'd like to support Roland, you can do so by <a href="https://paypal.me/draemmli">PayPal</a>. If you donate more than 10(€/$/CHF/mBTC), He'll (hopefully) send you a nice sticker of the 2017 Place canvas!</p>
|
||||
|
||||
<h2>Contributing</h2>
|
||||
<p>The Atlas relies on user contributions.</p>
|
||||
<p>To contribute a label for an artwork, please read <a href="https://www.reddit.com/r/placeAtlas2/comments/tu203o/how_to_contribute/">this post on Reddit</a> to learn how to submit a new entry. Alternatively, contributions can be made directly on <a href="https://github.com/placeAtlas/atlas/blob/master/CONTRIBUTING.md">GitHub</a>.</p>
|
||||
<p>The <a href="https://reddit.com/r/placeAtlas2/">r/placeAtlas2</a> subreddit is also the place to submit all bug reports, feature requests or questions.</p>
|
||||
<p>This project is open source, and contributions are welcome. In fact, the Atlas relies on user contributions.</p>
|
||||
<p>To contribute a label for an artwork, please read <a href="https://github.com/placeAtlas/atlas/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a> to learn how to submit a new entry, edit existing entries, or contribute to the development of the codebase.</p>
|
||||
<p><a href="https://reddit.com/r/placeAtlas2/">The r/placeAtlas2 subreddit</a> and <a href="https://discord.gg/pJkm23b2nA">the Discord server</a> is also the place to submit all bug reports, feature requests, or questions.</p>
|
||||
|
||||
<div id="credits">
|
||||
<h2>Credit</h2>
|
||||
|
|
|
|||
Loading…
Reference in a new issue