Skip to content

Commit 5fb31d2

Browse files
committed
add boilerplate files
Prep for move to nodejs org Add boilerplate files
1 parent cc73328 commit 5fb31d2

File tree

3 files changed

+127
-0
lines changed

3 files changed

+127
-0
lines changed

AUTHORS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Michael Dawson <[email protected]>

CONTRIBUTING.md

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# Contributing to create-node-meeting-artifacts
2+
3+
This document will guide you through the contribution process.
4+
5+
### Step 1: Fork
6+
7+
Fork the project [on GitHub](https://github.com/nodejs/create-node-meeting-artifacts)
8+
and check out your copy locally.
9+
10+
```bash
11+
$ git clone [email protected]:username/create-node-meeting-artifacts
12+
$ cd node-core-utils
13+
$ git remote add upstream [email protected]:nodejs/create-node-meeting-artifacts.git
14+
```
15+
16+
#### Which branch?
17+
18+
For developing new features and bug fixes, the `master` branch should be pulled
19+
and built upon.
20+
21+
### Step 2: Branch
22+
23+
Create a feature branch and start hacking:
24+
25+
```bash
26+
$ git checkout -b my-feature-branch -t origin/my-feature-branch
27+
```
28+
29+
### Step 3: Commit
30+
31+
Make sure git knows your name and email address:
32+
33+
```bash
34+
# In the project directory
35+
$ git config user.name "J. Random User"
36+
$ git config user.email "[email protected]"
37+
```
38+
39+
Writing good commit logs is important. A commit log should describe what
40+
changed and why. Follow these guidelines when writing one:
41+
42+
1. The first line should be a short description of the change
43+
(e.g. "get-metadata: check if the committer matches the author").
44+
2. Keep the second line blank.
45+
3. Wrap all lines at 72 columns.
46+
47+
The header line should be meaningful; it is what other people see when they
48+
run `git shortlog` or `git log --oneline`.
49+
50+
If your patch fixes an open issue, you can add a reference to it at the end
51+
of the log. Use the `Fixes:` prefix and the full issue URL. For example:
52+
53+
```
54+
Fixes: https://github.com/nodejs/create-node-meeting-artifacts/issues/1
55+
```
56+
57+
### Step 4: Rebase
58+
59+
Use `git rebase` (not `git merge`) to sync your work from time to time.
60+
61+
```bash
62+
$ git checkout my-feature-branch
63+
$ git fetch upstream
64+
$ git rebase upstream/master
65+
```
66+
67+
### Step 5: Push
68+
69+
```bash
70+
$ git push origin my-feature-branch
71+
# Or if you have pushed before and have rebased after that,
72+
# do git push --force origin my-feature-branch instead
73+
```
74+
75+
Go to https://github.com/yourusername/create-node-meeting-artifacts and
76+
select your feature branch. Click the 'Pull Request' button
77+
and fill out the form.
78+
79+
Pull requests are usually reviewed within a few days. If there are comments
80+
to address, apply your changes in a separate commit and push that to your
81+
feature branch. Post a comment in the pull request afterwards.
82+
83+
## Code of Conduct
84+
85+
We follow the
86+
[Node.js Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
87+
in this project.
88+
89+
## Developer's Certificate of Origin 1.1
90+
91+
By making a contribution to this project, I certify that:
92+
93+
* (a) The contribution was created in whole or in part by me and I
94+
have the right to submit it under the open source license
95+
indicated in the file; or
96+
97+
* (b) The contribution is based upon previous work that, to the best
98+
of my knowledge, is covered under an appropriate open source
99+
license and I have the right under that license to submit that
100+
work with modifications, whether created in whole or in part
101+
by me, under the same open source license (unless I am
102+
permitted to submit under a different license), as indicated
103+
in the file; or
104+
105+
* (c) The contribution was provided directly to me by some other
106+
person who certified (a), (b) or (c) and I have not modified
107+
it.
108+
109+
* (d) I understand and agree that this project and the contribution
110+
are public and that a record of the contribution (including all
111+
personal information I submit with it, including my sign-off) is
112+
maintained indefinitely and may be redistributed consistent with
113+
this project or the open source license(s) involved.

LICENSE.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
The MIT License (MIT)
2+
=====================
3+
4+
Copyright (c) 2018 create-node-meeting-artifacts authors
5+
-------------------------------------------------------------
6+
7+
*contributors listed at <https://github.com/nodejs/create-node-meeting-artifacts/blob/master/AUTHORS>*
8+
9+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)