Skip to content

Commit 4a0f07f

Browse files
chore(CONTRIBUTING.md): introduce (#18)
1 parent 1893931 commit 4a0f07f

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

Diff for: CONTRIBUTING.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# nodejs-loaders.github.io Contributing Guide
2+
3+
Thank you for considering contributing to Node.js Loaders website! Contributions welcome, be they bug reports, feature requests, pull requests, or just questions.
4+
5+
## Getting started
6+
7+
Commands specifically relevant to this project are:
8+
9+
Run the frontend unit tests:
10+
11+
```bash
12+
node --run test:unit
13+
```
14+
15+
Lint, format, and check types can be handled by:
16+
17+
```bash
18+
node --run pre-commit
19+
```
20+
21+
## Writing Content (Posts)
22+
23+
To contribute a new post, create a new `.mdx` file in the `content/post/` directory. The file should include the following frontmatter:
24+
25+
- `title`: The title of the post (string).
26+
- `description`: A brief description of the post (string).
27+
- `authors`: An array of author names (string).
28+
- `date`: The date of the post in `YYYY-MM-DD` format (string).
29+
- `category`: The category of the post (string).
30+
31+
Here's an example:
32+
33+
```mdx
34+
---
35+
title: Your Post Title
36+
description: A brief description of your post.
37+
authors: YourName
38+
date: 2025-02-07
39+
category: example
40+
---
41+
```
42+
43+
Your post content goes here. You can use Markdown and JSX.
44+
45+
## Pull Requests
46+
47+
Changes should be atomic; do not combine multiple, discrete changes within a single PR.
48+
49+
We use [squash merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) to create a single fresh commit based on PR title. The PR title should follow [Conventional Commit guidelines](https://www.conventionalcommits.org/en/v1.0.0/). Acceptable "types" are:
50+
51+
Before a pull request is merged, the following requirements should be met:
52+
53+
- The pull request has a descriptive title and follows the commit message guidelines.
54+
- An approval is valid if there have been no major changes since it was granted.
55+
- 24 hours after approval and no objections, the pull request can be merged.
56+
- All tests pass (Github actions).
57+
58+
## [Developer's Certificate of Origin 1.1](https://developercertificate.org)
59+
60+
```txt
61+
By contributing to this project, I certify that:
62+
63+
- (a) The contribution was created in whole or in part by me and I have the right to
64+
submit it under the open source license indicated in the file; or
65+
- (b) The contribution is based upon previous work that, to the best of my knowledge,
66+
is covered under an appropriate open source license and I have the right under that
67+
license to submit that work with modifications, whether created in whole or in part
68+
by me, under the same open source license (unless I am permitted to submit under a
69+
different license), as indicated in the file; or
70+
- (c) The contribution was provided directly to me by some other person who certified
71+
(a), (b) or (c) and I have not modified it.
72+
- (d) I understand and agree that this project and the contribution are public and that
73+
a record of the contribution (including all personal information I submit with it,
74+
including my sign-off) is maintained indefinitely and may be redistributed consistent
75+
with this project or the open source license(s) involved.
76+
```

0 commit comments

Comments
 (0)