Skip to content

Commit d2c26e1

Browse files
authored
Add CONTRIBUTING.md, issue and pr templates (#190)
* Add issue and pull request templates, and created contributing guidelines * Added build instructions * Improved the comments and added the Documentation type of change
1 parent 35d2742 commit d2c26e1

File tree

6 files changed

+153
-0
lines changed

6 files changed

+153
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Report something that is not working as expected
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
### What is the expected and actual behavior?
10+
11+
The library should do XXX but it's instead doing YYY
12+
13+
### Platform details
14+
15+
<!--
16+
Please provide as much information as possible here about the environment where you experinced the issue.
17+
Delete any row that doesn't apply to your issue.
18+
-->
19+
20+
I'm running the application in
21+
22+
- A Browser: _Example: chrome, firefox, edge..._
23+
- Node: _Example: v22.14.0_
24+
- Other: _Example: Deno..._
25+
26+
I'm using:
27+
28+
- Typescript
29+
- Babel
30+
- ESBuild
31+
- TSC
32+
- Other
33+
34+
### How to replicate the issue?
35+
36+
<!-- Please be specific as possible. Use dashes (-) or numbers (1.) to create a list of steps. If possible provide a code snippet or a link to a repo where the problem can be reproduced. -->
37+
38+
### Other Comments
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
## Feature Request
10+
11+
<!-- Thank you for taking the time to suggest a feature for our library! Please fill out the following details to help us understand your request better. -->
12+
13+
### Is your feature request related to a problem? Please describe.
14+
15+
<!-- A clear and concise description of the problem. Example: "I'm frustrated when..." -->
16+
17+
### Describe the solution you'd like to see implemented
18+
19+
<!-- A clear and concise description of what you want to happen. -->
20+
21+
### Describe any alternative you've considered
22+
23+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
24+
25+
### Additional context
26+
27+
<!-- Add any other context, screenshots, or code examples about the feature request here. -->
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Support request
3+
about: Ask for help with a problem that is hard to solve
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
### Problem description
10+
11+
<!-- Please provide a clear and concise description of the issue or question you need help with. -->
12+
13+
## Steps to Reproduce/Minimal example
14+
15+
<!-- If applicable, list the steps to reproduce the issue: -->
16+
17+
1.
18+
2.
19+
3.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
### Description
2+
3+
<!-- Please include a summary of the changes and the related issue. Highlight any key points or decisions made. -->
4+
5+
Fixes #(issue1)
6+
7+
### Type of Change
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation
13+
14+
### Checklist
15+
16+
<!-- Please remove any step that doesn't apply. You can remove the section entirely if not relevant -->
17+
18+
- [ ] My code follows the style guidelines of this project.
19+
- [ ] I have performed a self-review of my code.
20+
- [ ] I have commented my code, particularly in hard-to-understand areas.
21+
- [ ] I have added tests that prove my fix is effective or that my feature works.
22+
- [ ] New and existing unit tests pass locally with my changes.
23+
24+
### Screenshots (if applicable)
25+
26+
<!-- Add screenshots to help explain your changes. You can remove the section entirely if not relevant -->
27+
28+
### Additional Notes
29+
30+
<!-- Include any other relevant information or context. You can remove the section entirely if not relevant -->

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to Serializr
2+
3+
Thank you for considering contributing to Serializr! Please follow these guidelines to ensure a smooth contribution process.
4+
5+
## Guidelines
6+
7+
1. **Create an Issue First**
8+
Before creating a pull request (PR), please open an issue to discuss your proposed changes.
9+
10+
2. **Use Yarn**
11+
This project uses `yarn` for dependency management. Please ensure you use `yarn` instead of `npm`.
12+
13+
3. **Include Unit Tests**
14+
Any PR must include relevant unit tests to ensure the stability of the project.
15+
16+
4. **Lint Your Code**
17+
Use `eslint` to check your code and resolve any suggestions or errors before submitting your PR. We suggest integrating `eslint` directly into your IDE for a seamless development experience.
18+
19+
5. **Format with Prettier**
20+
Use `prettier` to ensure consistent code formatting across the project. We also recommend setting up `prettier` in your IDE to automatically format your code.
21+
22+
6. **Search Existing Issues**
23+
Before opening a new issue, please search the existing issues to avoid duplicates.
24+
25+
## Setting up the environment
26+
27+
At the moment to setup your working environment you must do the following steps:
28+
29+
- `yarn`
30+
- `yarn build`
31+
32+
Once this is done you will be able to run automated tests with
33+
34+
- `yarn test`
35+
36+
**NOTE:** if you accidentally run `npm install` please revert any change it introduces. It is a known issue that running `npm install` corrupts the dependency tree
37+
38+
We appreciate your contributions and look forward to collaborating with you!

0 commit comments

Comments
 (0)