From 7833a984e2e88214bfbd81a97b3cb232aa3ba363 Mon Sep 17 00:00:00 2001 From: Buay Kun Gach Date: Mon, 23 Mar 2026 15:10:43 +0300 Subject: [PATCH] docs: add CONTRIBUTING.md to guide contributors (#18) --- CONTRIBUTING.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7c84743 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,112 @@ +# Contributing to BOS + +Thank you for your interest in contributing to BOS (Bugema Operating System)! This document provides guidelines and instructions to help you get started. + +## Getting Started + +### Prerequisites +- Git installed on your machine +- A GitHub account +- Node.js (v16 or higher) and npm/yarn + +### Setting Up Your Development Environment + +1. **Fork the repository** + - Visit https://github.com/bos-com/BOS + - Click the "Fork" button + +2. **Clone your fork** + ```bash + git clone https://github.com/YOUR_USERNAME/BOS.git + cd BOS + ``` + +3. **Add the upstream remote** + ```bash + git remote add upstream https://github.com/bos-com/BOS.git + ``` + +4. **Install dependencies** + ```bash + npm install + ``` + +## How to Contribute + +### Reporting Bugs + +Before creating a bug report, please: +- Check if the issue already exists in the [issue tracker](https://github.com/bos-com/BOS/issues) +- Use the bug report template when creating a new issue +- Provide detailed steps to reproduce the problem + +### Suggesting Enhancements + +- Use the feature request template +- Clearly describe the enhancement and its benefits +- Provide examples if possible + +### Pull Requests + +1. **Create a new branch** + ```bash + git checkout -b feature/your-feature-name + ``` + +2. **Make your changes** + - Write clear, concise code + - Follow the existing code style + - Add comments where necessary + +3. **Commit your changes** + ```bash + git add . + git commit -m "type: description of your changes" + ``` + + Commit message format: `type: description` + - Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore` + +4. **Push to your fork** + ```bash + git push origin feature/your-feature-name + ``` + +5. **Create a Pull Request** + - Go to your fork on GitHub + - Click "New Pull Request" + - Fill out the PR template + - Link any related issues + +## Development Guidelines + +### Code Style +- Follow existing code formatting +- Use meaningful variable and function names +- Keep functions small and focused +- Write self-documenting code + +### Testing +- Write tests for new features +- Ensure all tests pass before submitting PR +- Run tests locally: `npm test` + +### Documentation +- Update README.md if needed +- Add inline comments for complex logic +- Update relevant documentation files + +## Community Guidelines + +- Be respectful and constructive in discussions +- Help others learn and grow +- Ask questions if something is unclear +- Share knowledge and best practices + +## Questions? + +If you have questions or need help: +- Open an issue with the "question" label +- Join our community discussions + +Thank you for contributing to BOS!