chore: add repository documentation and templates

suin · suin · commit a69de84d8e96 · 2024-12-12T15:28:39.000+09:00
Signed-off-by: suin &lt;suinyeze@gmail.com&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Module Name**
+Which module has the bug? (e.g., filepath)
+
+**Describe the bug**
+A clear description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Import module '...'
+2. Use function '....'
+3. With input '....'
+4. See error
+
+**Expected behavior**
+What you expected to happen.
+
+**Actual behavior**
+What actually happened.
+
+**Code Example**
+```python
+# Add your KCL code here
+```
+
+**Environment:**
+ - OS: [e.g., macOS]
+ - KCL Version: [e.g., 0.5.0]
+ - Module Version: [e.g., 1.0.0]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,30 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Module Name**
+Which module is this feature request for? (e.g., filepath, or "New Module" if proposing a new one)
+
+**Is your feature request related to a problem? Please describe.**
+A clear description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear description of any alternative solutions or features you've considered.
+
+**Example Usage**
+If possible, show how you would like to use this feature in KCL code:
+
+```python
+# Your example KCL code here
+```
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,30 @@
+## Description
+
+Please include:
+- What changes does this PR introduce?
+- Which module is affected?
+- Why was this change needed?
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Performance improvement
+- [ ] Code cleanup or refactor
+
+## How Has This Been Tested?
+
+Please describe the tests you added or the existing tests that cover this change.
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have updated the documentation accordingly
+- [ ] My changes generate no new warnings
+- [ ] I have added examples to demonstrate the new feature (if applicable)
+
+## Additional Notes
+
+Any additional information that would be helpful for reviewers.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,60 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement through GitHub issues.
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,75 @@
+# Contributing to KCL Modules
+
+Thank you for your interest in contributing to our KCL Modules! This document provides guidelines and instructions for contributing.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## How to Contribute
+
+### Reporting Bugs
+
+1. Check if the bug has already been reported in our [Issues](https://github.com/appthrust/kcl-modules/issues)
+2. If not, create a new issue using the bug report template
+3. Include as much detail as possible:
+   - Which module you're using
+   - What you expected to happen
+   - What actually happened
+   - Steps to reproduce
+   - Code examples
+
+### Suggesting Enhancements
+
+1. Check if the enhancement has already been suggested in our [Issues](https://github.com/appthrust/kcl-modules/issues)
+2. If not, create a new issue using the feature request template
+3. Describe your use case and why this enhancement would be useful
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a new branch for your changes
+3. Make your changes
+4. Add or update tests as needed
+5. Update documentation if needed
+6. Submit a pull request using our pull request template
+
+## Development Setup
+
+1. Install KCL
+2. Clone the repository
+3. Install dependencies:
+   ```bash
+   nix develop
+   ```
+
+## Adding a New Module
+
+1. Create a new directory for your module
+2. Include:
+   - README.md with documentation
+   - kcl.mod file
+   - Source code files
+   - Test files
+3. Update the top-level README.md to include your module
+
+## Testing
+
+- Write tests for any new functionality
+- Run tests using:
+  ```bash
+  kcl test ./...
+  ```
+
+## Documentation
+
+- Keep READMEs up to date
+- Document all public functions and types
+- Include examples in documentation
+- Update the changelog when making changes
+
+## Questions?
+
+Feel free to create an issue for any questions about contributing.
+
+Thank you for contributing to KCL Modules!
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 AppThrust
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# KCL Modules
+
+This is a monorepo containing useful KCL modules that help you write better KCL code.
+
+## Available Modules
+
+### filepath
+
+A module that helps you work with file paths safely and consistently. [Learn more](./filepath/README.md)
+
+## Installation
+
+Each module can be installed using the KCL package manager. For example:
+
+```bash
+# Install filepath module
+kcl mod add oci://ghcr.io/appthrust/kcl/filepath
+```
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
