瀏覽代碼

add contributing guidelines and issue templates

alexchenzl 5 月之前
父節點
當前提交
49e370c7f8
共有 3 個文件被更改,包括 123 次插入0 次删除
  1. 56 0
      .github/ISSUE_TEMPLATE/bug_report.yml
  2. 31 0
      .github/ISSUE_TEMPLATE/feature_request.yml
  3. 36 0
      CONTRIBUTING.md

+ 56 - 0
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,56 @@
+name: Bug Report
+description: Create a report to help us improve NanoBrowser
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+  - type: input
+    id: version
+    attributes:
+      label: Nanobrowser Version
+      description: What version of NanoBrowser are you running?
+      placeholder: e.g., 0.1.0
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: A clear and concise description of what the bug is
+      placeholder: Tell us what happened...
+    validations:
+      required: true
+      
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior
+      placeholder: |
+        1. set '...'
+        2. Click on '....'
+    validations:
+      required: true
+      
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you using?
+      options:
+        - macOS
+        - Windows
+        - Linux
+    validations:
+      required: true
+ 
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem

+ 31 - 0
.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,31 @@
+name: Feature
+description: Suggest an idea for Nanobrowser
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a new feature!
+        
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem does this solve?
+      placeholder: I'm frustrated when [...]
+    validations:
+      required: true
+      
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed solution
+      description: What would you like to see happen?
+    validations:
+      required: true
+      
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any relevant context, screenshots, or mockups

+ 36 - 0
CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing to NanoBrowser
+
+We deeply appreciate your interest in contributing to NanoBrowser! Every contribution helps make Nanobrowser more powerful and accessible for everyone.
+
+## Quick Start
+
+1. Fork and clone the repository
+2. Create a new branch (`git checkout -b feature-name`)
+3. Make your changes
+4. Submit a Pull Request
+
+## How Can I Contribute?
+
+### Reporting Bugs
+- Search existing issues first
+- Include:
+  - Clear description
+  - Steps to reproduce
+  - Environment details (OS, browser version)
+  - Screenshots if applicable
+
+### Suggesting Enhancements
+- Open an issue with a clear title and detailed description
+- Explain why this enhancement would be useful
+
+### Code Contributions
+1. Follow the existing code style
+2. Write clear commit messages in present tense ("Add feature" not "Added feature")
+3. Test your changes thoroughly
+4. Update documentation if needed
+5. Create a Pull Request with a clear description
+6. Be responsive to feedback and address review comments promptly
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the project's license terms.