Skip to content

Commit 91b7c2c

Browse files
Cod-e-CodesCod-e-Codes
committed
chore: Add community standards and documentation
1 parent fba833f commit 91b7c2c

6 files changed

Lines changed: 268 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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+
**Describe the Bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Run command '...'
15+
2. Navigate to '...'
16+
3. Press key '...'
17+
4. See error
18+
19+
**Expected Behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Actual Behavior**
23+
What actually happened.
24+
25+
**Environment**
26+
- OS: [e.g., Windows 10, Ubuntu 20.04]
27+
- Go Version: [e.g., 1.24.4]
28+
- Parsec Version: [e.g., 1.7.0]
29+
- Terminal: [e.g., PowerShell, iTerm2]
30+
31+
**Additional Context**
32+
- File types involved
33+
- Directory size/structure
34+
- Terminal dimensions
35+
- Any relevant error messages
36+
37+
**Screenshots**
38+
If applicable, add screenshots to help explain your problem.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem?**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Use Cases**
19+
Describe specific scenarios where this feature would be useful.
20+
21+
**Implementation Ideas**
22+
If you have any thoughts on how this could be implemented, share them here.
23+
24+
**Additional Context**
25+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Description
2+
Please include a summary of the changes and which issue is fixed. Include relevant motivation and context.
3+
4+
Fixes # (issue)
5+
6+
## Type of Change
7+
Please delete options that are not relevant.
8+
9+
- [ ] Bug fix (non-breaking change fixing an issue)
10+
- [ ] New feature (non-breaking change adding functionality)
11+
- [ ] Breaking change (fix or feature causing existing functionality to break)
12+
- [ ] Documentation update
13+
14+
## Testing Performed
15+
Describe the tests you ran to verify your changes. Provide instructions to reproduce.
16+
17+
- [ ] Test A
18+
- [ ] Test B
19+
20+
## Checklist
21+
- [ ] My code follows the style guidelines of this project
22+
- [ ] I have performed a self-review of my code
23+
- [ ] I have commented my code, particularly in hard-to-understand areas
24+
- [ ] I have made corresponding changes to the documentation
25+
- [ ] My changes generate no new warnings
26+
- [ ] I have tested my changes in multiple terminal sizes
27+
- [ ] I have tested on both Windows and Unix (if applicable)
28+
29+
## Screenshots (if appropriate)
30+
Add screenshots to help explain your changes.
31+
32+
## Additional Notes
33+
Add any other context about the changes here.

‎CODE_OF_CONDUCT.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment:
15+
16+
* Using welcoming and inclusive language
17+
* Being respectful of differing viewpoints and experiences
18+
* Gracefully accepting constructive criticism
19+
* Focusing on what is best for the community
20+
* Showing empathy towards other community members
21+
22+
Examples of unacceptable behavior:
23+
24+
* The use of sexualized language or imagery, and sexual attention or advances
25+
* Trolling, insulting/derogatory comments, and personal or political attacks
26+
* Public or private harassment
27+
* Publishing others' private information without explicit permission
28+
* Other conduct which could reasonably be considered inappropriate
29+
30+
## Enforcement Responsibilities
31+
32+
Project maintainers are responsible for clarifying and enforcing standards of
33+
acceptable behavior and will take appropriate and fair corrective action in
34+
response to any behavior that they deem inappropriate, threatening, offensive,
35+
or harmful.
36+
37+
## Scope
38+
39+
This Code of Conduct applies within all community spaces, and also applies when
40+
an individual is officially representing the community in public spaces.
41+
42+
## Enforcement
43+
44+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
45+
reported to the project maintainers. All complaints will be reviewed and
46+
investigated promptly and fairly.
47+
48+
## Attribution
49+
50+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
51+
version 2.0, available at
52+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

‎CONTRIBUTING.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Contributing to Parsec
2+
3+
Thank you for your interest in contributing to Parsec! We welcome contributions from everyone.
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Clone your fork: `git clone https://github.com/your-username/parsec.git`
9+
3. Create a branch: `git checkout -b your-feature-name`
10+
4. Make your changes
11+
5. Test thoroughly
12+
6. Commit your changes: `git commit -m "Description of changes"`
13+
7. Push to your fork: `git push origin your-feature-name`
14+
8. Open a Pull Request
15+
16+
## Development Setup
17+
18+
1. Ensure you have Go 1.24.4 or later installed
19+
2. Install dependencies: `go mod tidy`
20+
3. Build the project: `go build .`
21+
22+
## Code Style
23+
24+
- Follow standard Go formatting guidelines
25+
- Use `gofmt` to format your code
26+
- Write descriptive commit messages
27+
- Add comments for non-obvious code
28+
- Update documentation when needed
29+
30+
## Testing
31+
32+
- Test your changes with various file types
33+
- Verify terminal resizing behavior
34+
- Check performance with large directories
35+
- Test on both Windows and Unix systems
36+
37+
## Pull Request Process
38+
39+
1. Update the README.md with details of significant changes
40+
2. Update the version numbers following [SemVer](http://semver.org/)
41+
3. Ensure all tests pass
42+
4. Link any relevant issues
43+
5. The PR will be merged once you have the sign-off of a maintainer
44+
45+
## Bug Reports
46+
47+
When filing an issue, please include:
48+
49+
- Your operating system and version
50+
- Steps to reproduce the issue
51+
- Expected vs actual behavior
52+
- Any relevant error messages
53+
- Screenshots if applicable
54+
55+
## Feature Requests
56+
57+
We welcome feature requests! Please provide:
58+
59+
- Clear description of the feature
60+
- Use cases and benefits
61+
- Potential implementation approach
62+
- Any relevant examples
63+
64+
## Questions?
65+
66+
Feel free to open an issue for any questions about contributing.
67+
68+
Thank you for helping make Parsec better!

‎SECURITY.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| ------- | ------------------ |
7+
| 1.x.x | :white_check_mark: |
8+
9+
## Reporting a Vulnerability
10+
11+
We take security seriously. If you discover a security vulnerability, please follow these steps:
12+
13+
1. **Do Not** open a public issue
14+
2. Email the maintainers directly at [security@example.com]
15+
3. Include detailed information about the vulnerability
16+
4. Allow up to 48 hours for an initial response
17+
5. Please do not disclose the issue publicly until we've addressed it
18+
19+
## What to Include
20+
21+
When reporting a vulnerability, please provide:
22+
23+
- Description of the vulnerability
24+
- Steps to reproduce
25+
- Potential impact
26+
- Suggested fix (if any)
27+
28+
## Our Commitment
29+
30+
We will:
31+
32+
- Acknowledge receipt within 48 hours
33+
- Provide regular updates on our progress
34+
- Credit you in the fix (unless you prefer to remain anonymous)
35+
- Keep you informed throughout the process
36+
37+
## Security Best Practices
38+
39+
When using Parsec:
40+
41+
1. Keep your Go installation up to date
42+
2. Use the latest released version
43+
3. Review file permissions carefully
44+
4. Be cautious when running in privileged directories
45+
46+
## Updates and Patches
47+
48+
- Security updates will be released as soon as possible
49+
- Updates will be clearly marked in release notes
50+
- Critical vulnerabilities will be directly communicated to users
51+
52+
Thank you for helping keep Parsec secure!

0 commit comments

Comments
 (0)