Skip to content

Commit 3e8651f

Browse files
tarkatronicjwilhelm-godaddy
tarkatronic
authored and
jwilhelm-godaddy
committed
Initial commit
0 parents  commit 3e8651f

13 files changed

+1974
-0
lines changed

‎.editorconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
indent_style = space
8+
indent_size = 2
9+
end_of_line = lf
10+
charset = utf-8
11+
trim_trailing_whitespace = true
12+
insert_final_newline = true

‎.env.dist

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
GITHUB_TOKEN=

‎.eslintrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"root": true,
3+
"extends": "godaddy"
4+
}

‎.gitignore

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# Snowpack dependency directory (https://snowpack.dev/)
45+
web_modules/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Microbundle cache
57+
.rpt2_cache/
58+
.rts2_cache_cjs/
59+
.rts2_cache_es/
60+
.rts2_cache_umd/
61+
62+
# Optional REPL history
63+
.node_repl_history
64+
65+
# Output of 'npm pack'
66+
*.tgz
67+
68+
# Yarn Integrity file
69+
.yarn-integrity
70+
71+
# dotenv environment variables file
72+
.env
73+
.env.test
74+
75+
# parcel-bundler cache (https://parceljs.org/)
76+
.cache
77+
.parcel-cache
78+
79+
# Next.js build output
80+
.next
81+
out
82+
83+
# Nuxt.js build / generate output
84+
.nuxt
85+
dist
86+
87+
# Gatsby files
88+
.cache/
89+
# Comment in the public line in if your project uses Gatsby and not Next.js
90+
# https://nextjs.org/blog/next-9-1#public-directory-support
91+
# public
92+
93+
# vuepress build output
94+
.vuepress/dist
95+
96+
# Serverless directories
97+
.serverless/
98+
99+
# FuseBox cache
100+
.fusebox/
101+
102+
# DynamoDB Local files
103+
.dynamodb/
104+
105+
# TernJS port file
106+
.tern-port
107+
108+
# Stores VSCode versions used for testing VSCode extensions
109+
.vscode-test
110+
111+
# yarn v2
112+
.yarn/cache
113+
.yarn/unplugged
114+
.yarn/build-state.yml
115+
.yarn/install-state.gz
116+
.pnp.*

‎CODE_OF_CONDUCT.md

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[email protected].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
127+
at [https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations
134+

‎CONTRIBUTING.md

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Contributing
2+
3+
Everyone is welcome to contribute to GoDaddy's Open Source Software.
4+
Contributing doesn’t just mean submitting pull requests. To get involved,
5+
you can report or triage bugs, and participate in discussions on the
6+
evolution of each project.
7+
8+
No matter how you want to get involved, we ask that you first learn what’s
9+
expected of anyone who participates in the project by reading the Contribution
10+
Guidelines.
11+
12+
**Please Note:** GitHub is for bug reports and contributions primarily -
13+
if you have a support question head over to [GoDaddy OSS Slack][slack].
14+
15+
## Answering Questions
16+
17+
One of the most important and immediate ways you can support this project is
18+
to answer questions on [Slack][slack] or [Github][issues]. Whether you’re
19+
helping a newcomer understand a feature or troubleshooting an edge case with a
20+
seasoned developer, your knowledge and experience with a programming language
21+
can go a long way to help others.
22+
23+
## Reporting Bugs
24+
25+
Before submitting a ticket, please search our [Issue Tracker][issues] to make
26+
sure it does not already exist and have a simple replication of the behavior. If
27+
the issue is isolated to one of the dependencies of this project, please create
28+
a Github issue in that project. All dependencies should be open source software
29+
and can be found on Github.
30+
31+
Submit a ticket for your issue, assuming one does not already exist:
32+
33+
- Create it on the project's [issue Tracker][issues].
34+
- Clearly describe the issue by following the template layout
35+
- Make sure to include steps to reproduce the bug.
36+
- A reproducible (unit) test could be helpful in solving the bug.
37+
- Describe the environment that (re)produced the problem.
38+
39+
## Triaging bugs or contributing code
40+
41+
If you're triaging a bug, first make sure that you can reproduce it. Once a bug
42+
can be reproduced, reduce it to the smallest amount of code possible. Reasoning
43+
about a sample or unit test that reproduces a bug in just a few lines of code
44+
is easier than reasoning about a longer sample.
45+
46+
From a practical perspective, contributions are as simple as:
47+
48+
1. Fork and clone the repo, [see Github's instructions if you need help.][fork]
49+
1. Create a branch for your PR with `git checkout -b pr/your-branch-name`
50+
1. Make changes on the branch of your forked repository.
51+
1. When committing, reference your issue (if present) and include a note about
52+
the fix.
53+
1. Please also add/update unit tests for your changes.
54+
1. Push the changes to your fork and submit a pull request to the 'main
55+
development branch' branch of the projects' repository.
56+
57+
If you are interested in making a large change and feel unsure about its overall
58+
effect, start with opening an Issue in the project's [Issue Tracker][issues]
59+
with a high-level proposal and discuss it with the core contributors through
60+
Github comments or in [Slack][slack]. After reaching a consensus with core
61+
contributors about the change, discuss the best way to go about implementing it.
62+
63+
> Tip: Keep your master branch pointing at the original repository and make
64+
> pull requests from branches on your fork. To do this, run:
65+
>
66+
> ```console
67+
> git remote add upstream https://github.com/godaddy/orglinter.git
68+
> git fetch upstream
69+
> git branch --set-upstream-to=upstream/master master
70+
> ```
71+
>
72+
> This will add the original repository as a "remote" called "upstream," Then
73+
> fetch the git information from that remote, then set your local master
74+
> branch to use the upstream master branch whenever you run git pull. Then you
75+
> can make all of your pull request branches based on this master branch.
76+
> Whenever you want to update your version of master, do a regular git pull.
77+
78+
## Code Review
79+
80+
Any open source project relies heavily on code review to improve software
81+
quality. All significant changes, by all developers, must be reviewed before
82+
they are committed to the repository. Code reviews are conducted on GitHub
83+
through comments on pull requests or commits. The developer responsible for a
84+
code change is also responsible for making all necessary review-related changes.
85+
86+
Sometimes code reviews will take longer than you would hope for, especially for
87+
larger features. Here are some accepted ways to speed up review times for your
88+
patches:
89+
90+
- Review other people’s changes. If you help out, others will more likely be
91+
willing to do the same for you.
92+
- Split your change into multiple smaller changes. The smaller your change,
93+
the higher the probability that somebody will take a quick look at it.
94+
- Mention the change on [Slack][slack]. If it is urgent, provide reasons why it
95+
is important to get this change landed. Remember that you are asking for valuable
96+
time from other professional developers.
97+
98+
**Note that anyone is welcome to review and give feedback on a change, but only
99+
people with commit access to the repository can approve it.**
100+
101+
## Attribution of Changes
102+
103+
When contributors submit a change to this project, after that change is
104+
approved, other developers with commit access may commit it for the author. When
105+
doing so, it is important to retain correct attribution of the contribution.
106+
Generally speaking, Git handles attribution automatically.
107+
108+
## Code Style and Documentation
109+
110+
Ensure that your contribution follows the standards set by the project's style
111+
guide with respect to patterns, naming, documentation and testing.
112+
113+
## Additional Resources
114+
115+
- [General GitHub Documentation](https://help.github.com/)
116+
- [GitHub Pull Request documentation](https://help.github.com/send-pull-requests/)
117+
118+
[issues]: https://github.com/godaddy/orglinter/issues
119+
[slack]: https://godaddy.com/engineering/slack/
120+
[fork]: https://help.github.com/en/articles/fork-a-repo

0 commit comments

Comments
 (0)