Skip to content

Commit b4934ce

Browse files
committed
fix: Move default branch to main and add contributors
This changes the main branch to `main` instead of `master` while also adding contributing guidelines docs and a `contributors` section to `package.json`. Semver: patch
1 parent 34ae183 commit b4934ce

File tree

5 files changed

+187
-19
lines changed

5 files changed

+187
-19
lines changed

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

+21-13
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,40 @@
55
We use a fork-and-PR process, also known as a triangular workflow. This process
66
is fairly common in open-source projects. Here's the basic workflow:
77

8-
1. Fork the repo to create your own. This repo is called the origin repo.
9-
2. Work your changes on a branch in your repo.
10-
3. Submit your changes as a PR against the upstream repo.
11-
4. Maintainers review your changes. If they ask for changes, you work on your
12-
origin repo's branch. Otherwise, the branch is merged to upstream's main
13-
trunk.
8+
1. Fork the upstream repo to create your own repo. This repo is called the origin repo.
9+
2. Clone the origin repo to create a working directory on your local machine.
10+
3. Work your changes on a branch in your working directory, then add, commit, and push your work to your origin repo.
11+
4. Submit your changes as a PR against the upstream repo. You can use the upstream repo UI to do this.
12+
5. Maintainers review your changes. If they ask for changes, you work on your
13+
origin repo's branch and then submit another PR. Otherwise, if no changes are made,
14+
then the branch with your PR is merged to upstream's main trunk, the main branch.
1415

1516
When you work in a triangular workflow, you have the upstream repo, the origin
16-
repo, and then your local clone of the origin repo. You fetch from upstream to
17-
local, push from local to origin, and then do a PR from origin to
17+
repo, and then your working directory (the clone of the origin repo). You do
18+
a `git fetch` from upstream to local, push from local to origin, and then do a PR from origin to
1819
upstream—a triangle.
1920

2021
If this workflow is too much to understand to start, that's ok! You can use
2122
GitHub's UI to make a change, which is autoset to do most of this process for
2223
you. We just want you to be aware of how the entire process works before
2324
proposing a change.
2425

26+
Thank you for your contributions; we appreciate you!
27+
2528
## License
2629

27-
Note that we use a standard MIT license on this repo.
30+
Note that we use a standard [MIT](./LICENSE) license on this repo.
2831

29-
## Issues and Bugs
32+
## Coding style
3033

31-
Please use GitHub Issues to submit issues and bugs. Also, please open an issue
32-
before opening a PR to discuss any changes you think need to be made.
34+
Code style is enforced by [eslint][]. Linting is applied CI builds when a pull request
35+
is made. The rule set being enforced is provided by [eslint-config-logdna][]
3336

3437
## Questions?
3538

36-
Reach out in the GitHub Issues, or email us at `opensource at logdna.com`.
39+
The easiest way to get our attention is to comment on an existing, or open a new
40+
[issue][].
41+
42+
[eslint]: https://eslint.org
43+
[eslint-config-logdna]: https://github.com/logdna/eslint-config-logdna
44+
[issue]: https://github.com/logdna/eslint-config-logdna/issues

Jenkinsfile

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ library 'magic-butler-catalogue'
33
def PROJECT_NAME = "tail-file-node"
44
def REPO = "logdna/${PROJECT_NAME}"
55
def TRIGGER_PATTERN = ".*@logdnabot.*"
6+
def DEFAULT_BRANCH = 'main'
67

78
pipeline {
89
agent none
@@ -95,7 +96,7 @@ pipeline {
9596
when {
9697
beforeAgent true
9798
not {
98-
branch 'master'
99+
branch DEFAULT_BRANCH
99100
}
100101
}
101102

@@ -120,15 +121,15 @@ pipeline {
120121
token: "${GITHUB_PACKAGES_TOKEN}"
121122
, dry: true
122123
, repo: REPO
123-
, branch: "master"
124+
, branch: DEFAULT_BRANCH
124125
)
125126
}
126127
}
127128

128129
stage('Release') {
129130
when {
130131
beforeAgent true
131-
branch 'master'
132+
branch DEFAULT_BRANCH
132133
}
133134

134135
agent {
@@ -156,7 +157,7 @@ pipeline {
156157
, dry: false
157158
, repo: REPO
158159
, NPM_PUBLISH_TOKEN: "${NPM_PUBLISH_TOKEN}"
159-
, branch: "master"
160+
, branch: DEFAULT_BRANCH
160161
)
161162
}
162163
}

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Coverage Status](https://coveralls.io/repos/github/logdna/tail-file-node/badge.svg?branch=master)](https://coveralls.io/github/logdna/tail-file-node?branch=master)
1+
[![Coverage Status](https://coveralls.io/repos/github/logdna/tail-file-node/badge.svg?branch=main)](https://coveralls.io/github/logdna/tail-file-node?branch=main)
22

33
# TailFile
44

package.json

+22-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,28 @@
3232
"url": "https://github.com/logdna/tail-file-node"
3333
},
3434
"homepage": "https://github.com/logdna/tail-file-node",
35-
"author": "LogDNA, Inc.",
35+
"author": {
36+
"name": "LogDNA, Inc.",
37+
"email": "help@logdna.com"
38+
},
39+
"contributors": [
40+
{
41+
"name": "Darin Spivey",
42+
"email": "darin.spivey@logdna.com"
43+
},
44+
{
45+
"name": "Jakub Jirutka",
46+
"email": "jakub@jirutka.cz"
47+
},
48+
{
49+
"name": "Ryan Mottley",
50+
"email": "ryan.mottley@logdna.com"
51+
},
52+
{
53+
"name": "Laura Santamaria",
54+
"email": "dev@nimbinatus.com"
55+
}
56+
],
3657
"license": "SEE LICENSE IN LICENSE",
3758
"eslintConfig": {
3859
"root": true,

0 commit comments

Comments
 (0)