Skip to content

Commit a126152

Browse files
committed
feat: nfrs
Signed-off-by: seven <zilisheng1996@gmail.com>
1 parent f7d5c00 commit a126152

File tree

4 files changed

+100
-0
lines changed

4 files changed

+100
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to serverless-adapter
2+
3+
## Introduction
4+
First off, thank you for considering contributing to serverless-adapter! It's people like you that make this project great.
5+
6+
## How to Contribute
7+
1. Fork the repository.
8+
2. Create a new branch (`git checkout -b [feat|doc|fix|refactor]/your-branch`).
9+
3. Make your changes.
10+
4. Commit your changes (`git commit -am 'Add new feature'`).
11+
5. Push to the branch (`git push origin feature-branch`).
12+
6. Create a new Pull Request.
13+
14+
## Code of Conduct
15+
Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expectations for behavior when contributing to this project.
16+
17+
## Reporting Issues
18+
If you find a bug, please create an issue using the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md). Provide as much detail as possible to help us understand and resolve the issue.
19+
20+
## Submitting Pull Requests
21+
- Ensure your code follows the project's coding standards.
22+
- Write clear, concise commit messages.
23+
- Include tests for any new functionality.
24+
- Ensure all tests pass before submitting your pull request.
25+
26+
## Coding Standards
27+
- Follow the typescript style Guide and pass all style checks
28+
- Use [Prettier](https://prettier.io/) for code formatting.
29+
- Ensure your code passes linting (`npm run lint:check`).
30+
31+
## Running Tests
32+
- Run tests with `npm test`.
33+
- Ensure all tests pass before submitting your pull request.
34+
35+
## Additional Resources
36+
- [Project Documentation](https://www.geekfun.club/products.html)
37+
- [GitHub Repository](https://github.com/geek-fun/serverless-adapter)
38+
- [GEEKFUN Community](https://www.geekfun.club/)

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Desktop (please complete the following information):**
14+
- OS: [e.g. macOS]
15+
- Node: [e.g. 18.0]
16+
- Version [e.g. 0.1]
17+
- Framework: [e.g. Express]
18+
- Framework Version [e.g. 0.1]
19+
20+
**Reproduce Steps**
21+
Steps to reproduce the behavior:
22+
1. deploy '...'
23+
2. Click on '....'
24+
...
25+
26+
**Expected behavior**
27+
A clear and concise description of what you expected to happen.
28+
29+
**Screenshots**
30+
If applicable, add screenshots to help explain your problem.
31+
32+
**Additional context**
33+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
feat|fix|refactor: summary title of the PR
2+
3+
Introduce a request id and a reference to latest request. Dismiss
4+
incoming responses other than from latest request.
5+
6+
Remove timeouts which were used to mitigate the racing issue but are
7+
obsolete now.
8+
9+
Refs: #123

0 commit comments

Comments
 (0)