Skip to content

Commit e2088a2

Browse files
committed
docs: Added docs for community standards.
1 parent d0c4089 commit e2088a2

File tree

5 files changed

+130
-0
lines changed

5 files changed

+130
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us reproduce and fix the bug
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/gventuri/pandas-ai/issues?q=is%3Aissue+sort%3Acreated-desc+).
9+
- type: textarea
10+
attributes:
11+
label: 🐛 Describe the bug
12+
description: |
13+
Please provide a clear and concise description of what the bug is.
14+
15+
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc.
16+
17+
Please also paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
18+
placeholder: |
19+
A clear and concise description of what the bug is.
20+
```
21+
Sample code to reproduce the problem
22+
```
23+
24+
```
25+
The error message you got, with the full traceback.
26+
````
27+
validations:
28+
required: true
29+
- type: markdown
30+
attributes:
31+
value: >
32+
Thanks for contributing 🎉!
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Documentation
2+
description: Report an issue related to the Resonate docs.
3+
title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: "Issue with current documentation:"
9+
description: >
10+
Please make sure to leave a reference to the document/code you're
11+
referring to.
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: 🚀 Feature request
2+
description: Submit a proposal/request for a new Resoante feature
3+
4+
body:
5+
- type: textarea
6+
id: feature-request
7+
attributes:
8+
label: 🚀 The feature
9+
description: >
10+
A clear and concise description of the feature proposal
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Motivation, pitch
16+
description: >
17+
Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too.
18+
validations:
19+
required: true
20+
- type: markdown
21+
attributes:
22+
value: >
23+
Thanks for contributing 🎉!

.github/PULL_REQUEST_TEMPLATE.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Refactor (does not change functionality, e.g. code style improvements, linting)
15+
- [ ] Documentation update
16+
17+
## How Has This Been Tested?
18+
19+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
20+
21+
Please include screenshots below if applicable.
22+
23+
## Checklist:
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my own code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes
32+
- [ ] Any dependent changes have been merged and published in downstream modules
33+
- [ ] I have checked my code and corrected any misspellings
34+
35+
## Maintainer Checklist
36+
37+
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number)
38+
- [ ] Tag the PR with the appropriate labels

SECURITY.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
We take the security of our project seriously. If you discover any security issues, please let us know immediately. We appreciate your responsible disclosure.
6+
7+
To report a security vulnerability, please follow these steps:
8+
9+
1. **Do not open an issue** to report the vulnerability. Publicly disclosing security issues can put the project at risk.
10+
11+
2. Send an email to [[email protected]](mailto:[email protected]) with a subject like "Security Vulnerability in Resonate".
12+
13+
3. Provide detailed information about the vulnerability, including steps to reproduce it, and any relevant code or configuration.
14+
15+
4. If possible, please offer a proposed fix for the vulnerability.
16+
17+
5. We will acknowledge your email within 7 Days, and we will work to address the issue as soon as possible.
18+
19+
## Security Measures
20+
21+
While we make every effort to maintain the security of our project, there are some security measures we have in place:
22+
23+
- Regular code reviews by the maintainers.
24+
- Keeping dependencies up to date.
25+
26+
Thank you for helping to make our project more secure!

0 commit comments

Comments
 (0)