Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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!