-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: seven <[email protected]>
- Loading branch information
Showing
4 changed files
with
98 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Contributing to ServerlessInsight | ||
|
||
## Introduction | ||
First off, thank you for considering contributing to ServerlessInsight! It's people like you that make this project great. | ||
|
||
## How to Contribute | ||
1. Fork the repository. | ||
2. Create a new branch (`git checkout -b [feat|doc|fix|refactor]/your-branch`). | ||
3. Make your changes. | ||
4. Commit your changes (`git commit -am 'Add new feature'`). | ||
5. Push to the branch (`git push origin feature-branch`). | ||
6. Create a new Pull Request. | ||
|
||
## Code of Conduct | ||
Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expectations for behavior when contributing to this project. | ||
|
||
## Reporting Issues | ||
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. | ||
|
||
## Submitting Pull Requests | ||
- Ensure your code follows the project's coding standards. | ||
- Write clear, concise commit messages. | ||
- Include tests for any new functionality. | ||
- Ensure all tests pass before submitting your pull request. | ||
|
||
## Coding Standards | ||
- Follow the typescript style Guide and pass all syle checkes | ||
- Use [Prettier](https://prettier.io/) for code formatting. | ||
- Ensure your code passes linting (`npm run lint:check`). | ||
|
||
## Running Tests | ||
- Run tests with `npm test`. | ||
- Ensure all tests pass before submitting your pull request. | ||
|
||
## Additional Resources | ||
- [Project Documentation](https://serverlessinsight.geekfun.club/) | ||
- [GitHub Repository](https://github.com/geek-fun/serverlessinsight) | ||
- [GEEKFUN Community](https://www.geekfun.club/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: "[BUG] " | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. macOS] | ||
- Version [e.g. 0.1] | ||
|
||
**Reproduce Steps** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: "[FEATURE] " | ||
labels: feature | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
feat|fix|refactor: summary title of the PR | ||
|
||
Introduce a request id and a reference to latest request. Dismiss | ||
incoming responses other than from latest request. | ||
|
||
Remove timeouts which were used to mitigate the racing issue but are | ||
obsolete now. | ||
|
||
Refs: #123 |