Skip to content

Commit 49d16e7

Browse files
bgrnwdbgrnwd
authored
Merge pull request #179 from American-Soccer-Analysis/151-add-a-contributingmd-file
Add Contributing, Code of Conduct, and license files
2 parents bde12cf + 0e1bd28 commit 49d16e7

5 files changed

Lines changed: 228 additions & 9 deletions

File tree

‎.github/workflows/docker.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,6 @@ jobs:
3838
- name: Generate artifact attestation
3939
uses: actions/attest-build-provenance@v4
4040
with:
41-
subject-name: index.docker.io/american-soccer-analysis/app
41+
subject-name: docker.io/american-soccer-analysis/app
4242
subject-digest: ${{ steps.push.outputs.digest }}
4343
push-to-registry: true

‎CODE_OF_CONDUCT.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Code of Conduct - American Soccer Analysis | Shiny App
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment for our
15+
community include:
16+
17+
* Demonstrating empathy and kindness toward other people
18+
* Being respectful of differing opinions, viewpoints, and experiences
19+
* Giving and gracefully accepting constructive feedback
20+
* Accepting responsibility and apologizing to those affected by our mistakes,
21+
and learning from the experience
22+
* Focusing on what is best not just for us as individuals, but for the
23+
overall community
24+
25+
Examples of unacceptable behavior include:
26+
27+
* The use of sexualized language or imagery, and sexual attention or advances
28+
* Trolling, insulting or derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or email
31+
address, without their explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying and enforcing our standards of
38+
acceptable behavior and will take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or reject
42+
comments, commits, code, wiki edits, issues, and other contributions that are
43+
not aligned to this Code of Conduct, or to ban
44+
temporarily or permanently any contributor for other behaviors that they deem
45+
inappropriate, threatening, offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies within all community spaces, and also applies when
50+
an individual is officially representing the community in public spaces.
51+
Examples of representing our community include using an official e-mail address,
52+
posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported to the community leaders responsible for enforcement at <support@americansocceranalysis.com>.
59+
All complaints will be reviewed and investigated promptly and fairly.
60+
61+
All community leaders are obligated to respect the privacy and security of the
62+
reporter of any incident.
63+
64+
## Attribution
65+
66+
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
67+
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
68+
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
69+
and was generated by [contributing.md](https://contributing.md/generator).

‎CONTRIBUTING.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<!-- omit in toc -->
2+
# Contributing to American Soccer Analysis | Shiny App
3+
4+
First off, thanks for taking the time to contribute! ❤️
5+
6+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
7+
8+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
9+
> - Star the project
10+
> - Skeet about it
11+
> - Refer this project in your project's readme
12+
> - Mention the project at local meetups and tell your friends/colleagues
13+
14+
<!-- omit in toc -->
15+
## Table of Contents
16+
17+
- [Code of Conduct](#code-of-conduct)
18+
- [I Have a Question](#i-have-a-question)
19+
- [I Want To Contribute](#i-want-to-contribute)
20+
- [Reporting Bugs](#reporting-bugs)
21+
- [Suggesting Enhancements](#suggesting-enhancements)
22+
23+
24+
## Code of Conduct
25+
26+
This project and everyone participating in it is governed by the
27+
[American Soccer Analysis | Shiny App Code of Conduct](https://github.com/American-Soccer-Analysis/asa-shiny-app/blob/main/CODE_OF_CONDUCT.md).
28+
By participating, you are expected to uphold this code. Please report unacceptable behavior
29+
to <support@americansocceranalysis.com>.
30+
31+
32+
## I Have a Question
33+
34+
> If you want to ask a question, we assume that you have read the available [Documentation]().
35+
36+
Before you ask a question, it is best to search for existing [Issues](https://github.com/American-Soccer-Analysis/asa-shiny-app/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
37+
38+
If you then still feel the need to ask a question and need clarification, we recommend the following:
39+
40+
- Open an [Issue](https://github.com/American-Soccer-Analysis/asa-shiny-app/issues/new).
41+
- Provide as much context as you can about what you're running into.
42+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
43+
44+
We will then take care of the issue as soon as possible.
45+
46+
## I Want To Contribute
47+
48+
> ### Legal Notice <!-- omit in toc -->
49+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
50+
51+
### Reporting Bugs
52+
53+
<!-- omit in toc -->
54+
#### Before Submitting a Bug Report
55+
56+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
57+
58+
- Make sure that you are using the latest version.
59+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check [this section](#i-have-a-question)).
60+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/American-Soccer-Analysis/asa-shiny-app/issues?q=label%3Abug).
61+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
62+
- Collect information about the bug:
63+
- Stack trace (Traceback)
64+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
65+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
66+
- Possibly your input and the output
67+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
68+
69+
<!-- omit in toc -->
70+
#### How Do I Submit a Good Bug Report?
71+
72+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <support@americansocceranalysis.com>.
73+
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
74+
75+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
76+
77+
- Open an [Issue](https://github.com/American-Soccer-Analysis/asa-shiny-app/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
78+
- Explain the behavior you would expect and the actual behavior.
79+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
80+
- Provide the information you collected in the previous section.
81+
82+
Once it's filed:
83+
84+
- The project team will label the issue accordingly.
85+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
86+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
87+
88+
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
89+
90+
91+
### Suggesting Enhancements
92+
93+
This section guides you through submitting an enhancement suggestion for American Soccer Analysis | Shiny App, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
94+
95+
<!-- omit in toc -->
96+
#### Before Submitting an Enhancement
97+
98+
- Make sure that you are using the latest version.
99+
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
100+
- Perform a [search](https://github.com/American-Soccer-Analysis/asa-shiny-app/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
101+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
102+
103+
<!-- omit in toc -->
104+
#### How Do I Submit a Good Enhancement Suggestion?
105+
106+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/American-Soccer-Analysis/asa-shiny-app/issues).
107+
108+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
109+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
110+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
111+
- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. <!-- this should only be included if the project has a GUI -->
112+
- **Explain why this enhancement would be useful** to most American Soccer Analysis | Shiny App users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
113+
114+
<!-- omit in toc -->
115+
## Attribution
116+
This guide is based on the [contributing.md](https://contributing.md/generator)!

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2020 American Soccer Analysis
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,41 @@
1+
<!-- omit in toc -->
12
# American Soccer Analysis | Shiny App
23

34
<p align="center">
45
<img src="www/asa_assets/asa_github_header.png" align="center" width="100%" alt="American Soccer Analysis logo">
56
</p>
67

7-
## About the App
8+
- [About](#about)
9+
- [Development](#development)
10+
- [Contributing](#contributing)
11+
- [Acknowledgments](#acknowledgments)
12+
- [Attribution](#attribution)
13+
- [License](#license)
14+
15+
## About
816

917
We built this interactive web application to give ASA's loyal readers more autonomy to sort, filter, and download our data. It features summary-level data of teams and players participating in the following competitions:
1018

1119
- Major League Soccer (MLS)
1220
- National Women's Soccer League (NWSL)
13-
- USL Championship
14-
- USL League One
15-
- MLS Next Pro
21+
- USL Championship (USLC)
22+
- USL League One (USL1)
23+
- USL Super League (USLS)
24+
- MLS Next Pro (MLSNP)
1625
- North American Soccer League (NASL)
1726

18-
## Running the app
27+
## Development
1928

20-
If you want to get started with the app quickly, we recommend using Docker. We've provided a build/run script for you in `./build.sh` that will run the app under the same memory constraints as it does in production. Please note: the first time you run this script, `renv` will have to install all dependencies, which can take _a while_ (~35 minutes). However, because of how we have setup [multi-stage Docker builds using renv](https://rstudio.github.io/renv/articles/docker.html), this should not be a problem afterward (unless you update the dependencies or renv.lock via `renv::snapshot()`).
29+
If you want to get started with the app quickly, we recommend using Docker. We've provided a build/run script for you in `./build.sh` that will run the app under the same memory constraints as it does in production. Please note: the first time you run this script, `renv` will have to install all dependencies, which can take _a while_ (~35 minutes). However, because of how we have setup [multi-stage Docker builds using renv](https://rstudio.github.io/renv/articles/docker.html), this should not be a problem afterward (unless you update the dependencies or `renv.lock` via `renv::snapshot()`).
2130

2231
## Contributing
2332

2433
If you'd like to report a bug or request a new feature, please use the [Issues tab](https://github.com/American-Soccer-Analysis/asa-shiny-app/issues) in this repository.
2534

2635
Alternatively, if you'd like to help us squash bugs or add new features, drop us a message first! From there, follow [these general guidelines](https://github.com/MarcDiethelm/contributing/blob/master/README.md) for making a clean pull request. When you clone the forked repository to your local machine, use [`renv::restore()`](https://rstudio.github.io/renv/articles/renv.html) to recreate the virtual R environment.
2736

37+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
38+
2839
## Acknowledgments
2940

3041
Thanks to the developers of these integral, open source libraries:
@@ -43,6 +54,8 @@ Thanks to the developers of these integral, open source libraries:
4354

4455
## Attribution
4556

46-
This application was built and is maintained by [Brian Greenwood](https://github.com/bgrnwd), [Matthias Kullowatz](https://github.com/mattyanselmo), [Rory Pulvino](https://github.com/rvino), and [Tyler Richardett](https://github.com/tyler-richardett).
47-
4857
If you use any of the data we make publicly available, we kindly ask that you provide credit and link back to the [American Soccer Analysis website](https://www.americansocceranalysis.com/). Thanks!
58+
59+
## License
60+
61+
See license in [LICENSE.md](./LICENSE.md)

0 commit comments

Comments
 (0)