Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme and other docs #14

Merged
merged 1 commit into from
Nov 16, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 19 additions & 20 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,33 @@
# Contributor Code of Conduct

* Overview *
### Overview

At its core, MapRules' goal is to support all mappers, regardless of expertise or background.
That same concept of being supportive applies to contributing to the project.
We want this to be a code base where anyone who contributes feels those time was were appreciated, meaningful, and not without support of other MapRules developers and users.

* Guidelines *
### Guidelines

* Have fun!
* Use respectful, inclusive language in tickets and pull requests.
* Contributors are diverse, coming from all walks of life and lines of work. Respect and consider their ideas as it will only make this tool better.
* Take and provide constructive criticism with grace. If somebody reviewed your code, just remember their suggestions will help you a learn as a programmer. If you are working through a pull request with another contributor, read others' code thoroughly. Try to understand what is going on before asking why. Hey, maybe even read some of [these suggestions](https://gooroo.io/GoorooTHINK/Article/16363/Developer-Etiquette--Code-Review-and-Pull-Request-Comments/19614#.W6bG99-YUsE) for writing good pull request review comments.
* Like OSM. this is a volunteer effort. Be patient if a new feature or bug fix doesn't come right away.
* If you are worried what you are going to say might be mean, don't say it or find another way to get your point across. A wise person once said - think, think, think, then speak.
* Be empathetic.
- Have fun!
- Use respectful, inclusive language in tickets and pull requests.
- Contributors are diverse, coming from all walks of life and lines of work. Respect and consider their ideas as it will only make this tool better.
- Take and provide constructive criticism with grace. If somebody reviewed your code, just remember their suggestions will help you a learn as a programmer. If you are working through a pull request with another contributor, read others' code thoroughly. Try to understand what is going on before asking why. Hey, maybe even read some of [these suggestions](https://gooroo.io/GoorooTHINK/Article/16363/Developer-Etiquette--Code-Review-and-Pull-Request-Comments/19614#.W6bG99-YUsE) for writing good pull request review comments.
- Like OSM. this is a volunteer effort. Be patient if a new feature or bug fix doesn't come right away.
- If you are worried what you are going to say might be mean, don't say it or find another way to get your point across. A wise person once said - think, think, think, then speak.
- Be empathetic.

* What we will not tolerate *
### What we will not tolerate

* Sexual language or imagery
* Public or private harassment
* Plagiarism (if you were stuck and found a solution on stack exchange, make it known in a comment!)
* Discriminatory actions (regardless of intention) directed at someone's race, sex, sexual orientation, religion, national origin, disability, age, or any other attribute.
* Trolling
* Hate speech
* Unprofessional conduct
- Sexual language or imagery
- Public or private harassment
- Plagiarism (if you were stuck and found a solution on stack exchange, make it known in a comment!)
- Discriminatory actions (regardless of intention) directed at someone's race, sex, sexual orientation, religion, national origin, disability, age, or any other attribute.
- Trolling
- Hate speech
- Unprofessional conduct

* Enforcement *

If you feel an instance is requisite with one of the above scenarios, contact the maintainers. They'll investigate and respond as deemed necessary. REsponses may include:
### Enforcement
If you feel an instance is requisite with one of the above scenarios, contact the maintainers. They'll investigate and respond as deemed necessary. Responses may include:
- editing or deleting comments, code, issues, or other sorts of contributions
- banning offenders temporarily or permanently

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Note, as the project grows, there may already be an issue addressing your issue.

When writing a ticket, make sure you include the following (as they apply)...

- [ ] Provide steps to replicate the error (i.e, I added this key and value condition, loaded up editor x. and problem y occurred)
- [ ] Share a related screenshot, or better yet a GIF!
- Provide steps to replicate the error (i.e, I added this key and value condition, loaded up editor x. and problem y occurred)
- Share a related screenshot, or better yet a GIF!
- For GIFS, [LICEcap](https://www.cockos.com/licecap/) is a goto for windows users, [peek](https://github.com/phw/peek) rules for linux, and [kap](https://getkap.co/) is a nice looking option for mac
- [ ] If you can share a stack trace, please do so!
- If you can share a stack trace, please do so!

# Labelling your issue.

Expand Down Expand Up @@ -101,7 +101,7 @@ closes #10

```
1. spin up maprules with fixture data
2. curl `${link.to.maprules}/config/${uuid}/osmlint` osmlint conf
2. curl `${link.to.maprules}/config/${uuid}/osmlint`
3. run the osmlint command `${some.osmlint.command} --confpath ${path.to.conf.you.downloaded}
4. see expected osmlint output.
```
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,26 @@ MapRules is an api service that allows mappers and mapping campaign managers to

The goal of MapRules is to simplify OpenStreetMap feature tagging and validation.

### Documentation
#### Documentation

- [MapRules Configuration Spec](https://github.com/maprules/maprules/blob/develop/maprules.spec.md)
- [Validation Scenarios](https://github.com/maprules/maprules/blob/develop/maprules.validation.scenarios.md)
- [Api Documentation](https://github.com/maprules/maprules/blob/develop/maprules.apidocs.md)
- [MapRules Configuration Spec](https://github.com/radiant-maxar/maprules/blob/master/maprules.spec.md)
- [Validation Scenarios](https://github.com/radiant-maxar/maprules/blob/master/maprules.validation.scenarios.md)
- [Api Documentation](https://github.com/radiant-maxar/maprules/blob/master/maprules.apidocs.md)

#### Contributing
- [Code of Conduct](https://github.com/radiant-maxar/maprules/blob/master/CODE_OF_CONDUCT.md)
- [Contributing](https://github.com/radiant-maxar/maprules/blob/master/CONTRIBUTING.md)

#### Links to other MapRules Repos

- [MapRules User Interface](https://github.com/radiant-maxar/maprules-ui)
- [iD Fork](https://github.com/radiant-maxar/iD/tree/remote-presets)
- [JOSM Plugin](https://github.com/radiant-maxar/maprules-josm)
- [MapCSS Parse](https://github.com/radiant-maxar/mapcss-parse)
- [Tasking Manager 2 Fork](https://github.com/radiant-maxar/osm-tasking-manager2/tree/maprules-dev)


...see the [Architecture](https://github.com/maprules/maprules/blob/master/ARCHITECTURE.md) for a technical decsription of the repos work together

## Getting Started

Expand Down