diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4ed3d70 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,47 @@ +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making +participation in our project, and our community a harassment-free experience for everyone, regardless of age, body size, +disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, +religion, or sexual identity and orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take +appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, +issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the +project or its community. Examples of representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed representative at an online or offline +event. Representation of a project may be further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior will not be tolerated in any way. +If you exhibit any of the mentioned unacceptable behaviors, your contributions will be denied. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0e367dd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contributing + +When contributing to this repository, make sure that your change is not already covered in an open issue or pull +request. If it is not covered, please feel free to open a pull request using our PR template. + +Please note we have a [code of conduct](#code-of-conduct), please follow it in all your interactions with the project. + +## Copyright and Data Ownership + +Any changes to the data hosted by this repository must respect the licensing rules documented by Games Workshop +here [Intellectual Property Policy](https://www.games-workshop.com/en-US/Intellectual-Property-Policy). + +We are in no way affiliated with Games Workshop and the Warhammer Age of Sigmar data is the sole property of Games +Workshop. We are abiding by their `Celebrating the Hobby` section of the agreement and not commercializing this data in +any way. This API is purely to help allow users to engage with the wonderful world of Warhammer in a programattic way +through a REST interface rather than the usual PDF. + +If you consume the data served through this API in your own application, be aware that you are also obligated to respect +[Games Workshop's](https://www.games-workshop.com) licensing agreements. + +## Pull Request Process + +1. If applicable, update the README.md with details of changes to the way the project is used or developed. +1. You may merge the Pull Request in once you have the sign-off of one other developer, or if you do not have permission + to do that, you may request the reviewer to merge it for you. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available +at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org + +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/README.md b/README.md index 1e3c4e9..93c9c93 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Go Reference](https://pkg.go.dev/badge/github.com/brittonhayes/warhammer.svg)](https://pkg.go.dev/github.com/brittonhayes/warhammer) [![Go Report Card](https://goreportcard.com/badge/github.com/brittonhayes/warhammer)](https://goreportcard.com/report/github.com/brittonhayes/warhammer) -> A Warhammer REST API built with Go and Sqlite. +> A Warhammer: Age of Sigmar REST API built with Go and Sqlite. ## ✨ Try the API (hosted) @@ -82,6 +82,21 @@ When running with docker-compose, the following services are available: - Prometheus is available at [http://prometheus.localhost:8090](http://prometheus.localhost:8090) - Grafana is available at [http://grafana.localhost:8090](http://grafana.localhost:8090) -## FAQ +## 🙋 FAQ -- **Q: Where is X {unit,alliance,etc}?** - A: Waiting for you to add it! See the [fixtures/](https://github.com/brittonhayes/warhammer/blob/main/fixtures/) directory for more information. \ No newline at end of file +- **Q: Where is X {unit,alliance,etc}?** - A: Waiting for you to add it! See the [fixtures/](https://github.com/brittonhayes/warhammer/blob/main/fixtures/) directory for more information. + +## ⚖️ Copyright and Data Ownership + +Any changes to the data hosted by this repository must respect the licensing rules documented by Games Workshop +here [Intellectual Property Policy](https://www.games-workshop.com/en-US/Intellectual-Property-Policy). + +We are in no way affiliated with Games Workshop and the Warhammer Age of Sigmar data is the sole property of Games +Workshop. We are abiding by their `Celebrating the Hobby` section of the agreement and not commercializing this data in +any way. This API is purely to help allow users to engage with the wonderful world of Warhammer in a programattic way +through a REST interface rather than the usual PDF. + +If you consume the data served through this API, be aware that you are also obligated to respect +[Games Workshop's](https://www.games-workshop.com) [intellectual property guidelines](https://www.games-workshop.com/en-US/Intellectual-Property-Guidelines). + +For more information, view our [Contributing Guidelines](https://github.com/brittonhayes/warhammer/blob/main/CONTRIBUTING.md). \ No newline at end of file