diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..a3f819c --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,16 @@ + +--- + +# AUTHORS + +This project is made possible by the following contributors: + +- **Hokam Singh** – Creator and Lead Maintainer + GitHub: [hokamsingh](https://github.com/hokamsingh) + +- **KlassnayaAfrodita** – Contributor + GitHub: [KlassnayaAfrodita](https://github.com/KlassnayaAfrodita) + +We thank all contributors for their support and input. If you'd like to contribute, please check the [CONTRIBUTE.md](CONTRIBUTE.md) file. + +--- diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..82b4e67 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,24 @@ + +--- + +# Contributor Code of Conduct + +## Our Pledge + +We pledge to foster an open and welcoming environment for everyone. All contributors, maintainers, and users are expected to engage respectfully. + +## Our Standards + +- Be respectful and considerate. +- Provide constructive feedback. +- Avoid offensive language or behavior. + +## Enforcement + +Instances of inappropriate conduct may be reported to the project team at singhhokam704@gmail.com. We will review and respond to reports in a fair and timely manner. + +## Scope + +This Code of Conduct applies within all project spaces and interactions. + +--- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6aef4f1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,68 @@ + +--- + +# Contributing to LessGo + +Thank you for considering contributing to **LessGo**! We welcome all contributions that help improve the framework. Below are the guidelines to follow when contributing. + +## Table of Contents + +- [How to Contribute](#how-to-contribute) +- [Code of Conduct](#code-of-conduct) +- [Reporting Issues](#reporting-issues) +- [Submitting Changes](#submitting-changes) +- [Style Guide](#style-guide) +- [Running Tests](#running-tests) +- [Feature Requests](#feature-requests) +- [Additional Resources](#additional-resources) + +## How to Contribute + +1. **Fork** the repository and **clone** it locally. +2. Create a **new branch** for your changes (e.g., `fix/issue-description`). +3. Ensure that your code adheres to the [Style Guide](#style-guide) and **is tested**. +4. Submit a **pull request** (PR) with a detailed description. + +## Code of Conduct + +Please follow the [Code of Conduct](CODE_OF_CONDUCT.md) to foster a welcoming community. + +## Reporting Issues + +- For bugs, include steps to reproduce, expected and actual behavior, and relevant logs. +- For feature requests, provide clear descriptions and reasons for the addition. + +## Submitting Changes + +- PRs should reference relevant issues (e.g., `Closes #issue_number`). +- Ensure that all tests pass and that your code is well-commented. + +## Style Guide + +- Use `gofmt` for consistent formatting. +- Follow idiomatic Go best practices and the repository's existing code style. +- Keep functions concise and modular. + +## Running Tests + +Before submitting any changes, ensure that all tests pass: + +```bash +go test ./... +``` + +If adding new features, include unit tests that cover the functionality. + +## Feature Requests + +For new features, open an issue and provide: +- A problem statement. +- Proposed solution or approach. +- Any relevant context or use cases. + +## Additional Resources + +- [Project Documentation](https://pkg.go.dev/github.com/hokamsingh/lessgo) +- [Issue Tracker](https://github.com/hokamsingh/lessgo/issues) + +--- \ No newline at end of file