Skip to content

Commit ab742c4

Browse files
committed
Add project management files.
Signed-off-by: David Calavera <david.calavera@gmail.com>
1 parent b5f6906 commit ab742c4

File tree

4 files changed

+187
-0
lines changed

4 files changed

+187
-0
lines changed

.github/ISSUE_TEMPLATE.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!--
2+
If you are reporting a new issue, make sure that we do not have any duplicates
3+
already open. You can ensure this by searching the issue list for this
4+
repository. If there is a duplicate, please close your issue and add a comment
5+
to the existing issue instead.
6+
7+
If you suspect your issue is a bug, please edit your issue description to
8+
include the BUG REPORT INFORMATION shown below. If you fail to provide this
9+
information within 7 days, we cannot debug your issue and will close it. We
10+
will, however, reopen it if you later provide the information.
11+
12+
---------------------------------------------------
13+
BUG REPORT INFORMATION
14+
---------------------------------------------------
15+
Use the commands below to provide key information from your environment:
16+
You do NOT have to include this information if this is a FEATURE REQUEST
17+
-->
18+
19+
**- Do you want to request a *feature* or report a *bug*?**
20+
21+
**- What is the current behavior?**
22+
23+
**- If the current behavior is a bug, please provide the steps to reproduce.**
24+
25+
**- What is the expected behavior?**
26+
27+
**- Please mention your node.js, NPM, Hugo and operating system version.**

.github/PULL_REQUEST_TEMPLATE.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
Thanks for submitting a pull request!
3+
4+
Please make sure you've read and understood our contributing guidelines;
5+
https://github.com/netlify/victor-hugo/blob/master/CONTRIBUTING.md
6+
7+
If this is a bug fix, make sure your description includes "fixes #xxxx", or
8+
"closes #xxxx", where #xxxx is the issue number.
9+
10+
Please provide enough information so that others can review your pull request.
11+
The first three fields are mandatory:
12+
-->
13+
14+
**- Summary**
15+
16+
<!--
17+
Explain the **motivation** for making this change.
18+
What existing problem does the pull request solve?
19+
-->
20+
21+
**- Test plan**
22+
23+
<!--
24+
Demonstrate the code is solid.
25+
Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
26+
-->
27+
28+
**- Description for the changelog**
29+
30+
<!--
31+
Write a short (one line) summary that describes the changes in this
32+
pull request for inclusion in the changelog:
33+
-->
34+
35+
**- A picture of a cute animal (not mandatory but encouraged)**

CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at david@netlify.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# CONTRIBUTING
2+
3+
Contributions are always welcome, no matter how large or small. Before contributing,
4+
please read the [code of conduct](CODE_OF_CONDUCT.md).
5+
6+
## Setup
7+
8+
> Install Hugo in your system: https://github.com/spf13/hugo/releases
9+
10+
```sh
11+
$ git clone https://github.com/netlify/victor-hugo
12+
$ cd victor-hugo
13+
$ npm install
14+
```
15+
16+
## Building
17+
18+
```sh
19+
$ npm run build
20+
```
21+
22+
## Testing
23+
24+
```sh
25+
$ npm run test
26+
```
27+
28+
```sh
29+
$ npm run test:watch
30+
```
31+
32+
## Runing the server
33+
34+
```sh
35+
$ npm run start
36+
```
37+
38+
## Pull Requests
39+
40+
We actively welcome your pull requests.
41+
42+
1. Fork the repo and create your branch from `master`.
43+
2. If you've added code that should be tested, add tests.
44+
3. If you've changed APIs, update the documentation.
45+
4. Ensure the test suite passes.
46+
5. Make sure your code lints.
47+
48+
## License
49+
50+
By contributing to Victor-Hugo, you agree that your contributions will be licensed
51+
under its [MIT license](LICENSE).

0 commit comments

Comments
 (0)