swadhin / opengrammar public

feat: add community templates and contributing guidelines

Swadhin Biswas committed 7 months ago
174ee26
1 parent e865633
commit 174ee26
4 files changed
+157 -0
Showing 4 changed files+157-0
.github/ISSUE_TEMPLATE/bug_report.yml.github/ISSUE_TEMPLATE/feature_request.ymlCODE_OF_CONDUCT.mdCONTRIBUTING.md
▼.github/ISSUE_TEMPLATE/bug_report.yml
+50-0
@@ -0,0 +1,50 @@
1
+name: Bug Report
2
+description: File a report to help us improve OpenGrammar
3
+title: "[BUG] "
4
+labels: ["bug", "triage"]
5
+body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Thanks for taking the time to fill out this bug report!
10
+ - type: textarea
11
+ id: description
12
+ attributes:
13
+ label: Describe the bug
14
+ description: A clear and concise description of what the bug is.
15
+ placeholder: Bug description
16
+ validations:
17
+ required: true
18
+ - type: textarea
19
+ id: reproduction
20
+ attributes:
21
+ label: Steps to Reproduce
22
+ description: Steps to reproduce the behavior.
23
+ placeholder: |
24
+ 1. Go to '...'
25
+ 2. Click on '....'
26
+ 3. Scroll down to '....'
27
+ 4. See error
28
+ validations:
29
+ required: true
30
+ - type: textarea
31
+ id: expected-behavior
32
+ attributes:
33
+ label: Expected Behavior
34
+ description: A clear and concise description of what you expected to happen.
35
+ validations:
36
+ required: true
37
+ - type: textarea
38
+ id: context
39
+ attributes:
40
+ label: Environment Context
41
+ description: Browser, OS, Backend version, etc.
42
+ placeholder: |
43
+ - OS: [e.g. Windows, macOS, Linux]
44
+ - Browser: [e.g. Chrome, Brave]
45
+ - OpenGrammar Version: [e.g. 2.0.0]
46
+ - type: textarea
47
+ id: screenshots
48
+ attributes:
49
+ label: Screenshots
50
+ description: If applicable, add screenshots to help explain your problem.
0
51
▼.github/ISSUE_TEMPLATE/feature_request.yml
+29-0
@@ -0,0 +1,29 @@
1
+name: Feature Request
2
+description: Suggest an idea for OpenGrammar
3
+title: "[FEATURE] "
4
+labels: ["enhancement"]
5
+body:
6
+ - type: textarea
7
+ id: feature-description
8
+ attributes:
9
+ label: Is your feature request related to a problem?
10
+ description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11
+ validations:
12
+ required: true
13
+ - type: textarea
14
+ id: solution
15
+ attributes:
16
+ label: Describe the solution you'd like
17
+ description: A clear and concise description of what you want to happen.
18
+ validations:
19
+ required: true
20
+ - type: textarea
21
+ id: alternatives
22
+ attributes:
23
+ label: Describe alternatives you've considered
24
+ description: A clear and concise description of any alternative solutions or features you've considered.
25
+ - type: textarea
26
+ id: additional-context
27
+ attributes:
28
+ label: Additional context
29
+ description: Add any other context or screenshots about the feature request here.
0
30
▼CODE_OF_CONDUCT.md
+31-0
@@ -0,0 +1,31 @@
1
+# Contributor Covenant Code of Conduct
2
+
3
+## Our Pledge
4
+
5
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+## Our Standards
8
+
9
+Examples of behavior that contributes to creating a positive environment include:
10
+
11
+* Using welcoming and inclusive language
12
+* Being respectful of differing viewpoints and experiences
13
+* Gracefully accepting constructive criticism
14
+* Focusing on what is best for the community
15
+* Showing empathy towards other community members
16
+
17
+Examples of unacceptable behavior by participants include:
18
+
19
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
20
+* Trolling, insulting/derogatory comments, and personal or political attacks
21
+* Public or private harassment
22
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
23
+* Other conduct which could reasonably be considered inappropriate in a professional setting
24
+
25
+## Our Responsibilities
26
+
27
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
+
29
+## Enforcement
30
+
31
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
0
32
▼CONTRIBUTING.md
+47-0
@@ -0,0 +1,47 @@
1
+# Contributing to OpenGrammar
2
+
3
+First off, thank you for considering contributing to OpenGrammar! It's people like you that make OpenGrammar such a great tool.
4
+
5
+## Code of Conduct
6
+
7
+By participating in this project, you are expected to uphold our Code of Conduct.
8
+
9
+## How Can I Contribute?
10
+
11
+### Reporting Bugs
12
+
13
+- **Check if it has already been reported** by searching through GitHub issues.
14
+- If you can't find an open issue addressing the problem, **open a new one** using the Bug Report template.
15
+
16
+### Suggesting Enhancements
17
+
18
+- **Check if it has already been suggested** by searching through GitHub issues.
19
+- **Open a new issue** using the Feature Request template.
20
+
21
+### Pull Requests
22
+
23
+1. **Fork the repository** and create your branch from `main`.
24
+2. **Install dependencies** using Bun: `bun install`.
25
+3. **Make your changes**.
26
+4. **Ensure the code passes all checks**: Run `bun x tsc` in the relevant directories.
27
+5. **Issue a Pull Request** with a clear description of your changes.
28
+
29
+## Development Setup
30
+
31
+We use **Bun** as our primary runtime and package manager.
32
+
33
+```bash
34
+# Backend
35
+cd opengrammar/backend
36
+bun install
37
+bun dev
38
+
39
+# Extension
40
+cd opengrammar/extension
41
+bun install
42
+bun run dev
43
+```
44
+
45
+## Community
46
+
47
+If you have questions or want to discuss ideas, feel free to open a GitHub Discussion!
0
48