You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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. -->
<!-- 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. -->
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