Skip to content

Add contributing guidelines including the current contributor list #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from 4 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
82 changes: 82 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Contributing to Capture

Thank you for your interest in contributing to Capture! Whether you're fixing bugs, adding features, or improving documentation, your efforts are appreciated.

## Getting Started

- **Star the Repository**: If you like the project, give it a star to show your support.
- **Join the Community**: Connect with us on [Discord](https://discord.com/invite/NAb6H3UTjK) for discussions and support.
- **Explore Issues**: Check out [open issues](https://github.com/bluewave-labs/capture/issues) and look for those labeled `good first issue` if you're new.

## Reporting Bugs

1. **Search Existing Issues**: Before reporting, see if the issue already exists.
2. **Open a New Issue**: If not found, create a new issue with:
- A clear title and description.
- Steps to reproduce the problem.
- Expected vs. actual behavior.
- Relevant logs or screenshots.

## Suggesting Features

1. **Check for Similar Requests**: Look through existing issues to avoid duplicates.
2. **Create a Feature Request**: If unique, open a new issue detailing:
- The problem you're addressing.
- Proposed solution or feature.
- Any alternatives considered.

## Architecture Overview

Read a detailed structure of Capture if you would like to deep dive into the architecture.

- [Architecture Overview](docs/README.md#high-level-overview)
- [Capture DeepWiki Page](https://deepwiki.com/bluewave-labs/capture)

## Development Setup

1. **Clone the Repository**:

```bash
git clone https://github.com/bluewave-labs/capture.git
cd capture

2. **Install Dependencies**:

```bash
go mod tidy
```

3. **Run the Application**:

```bash
go run cmd/capture/main.go
```

## Coding Guidelines

- **Code Style**: Follow Go conventions and project-specific guidelines.
- **Linting**: Run linters to catch issues early.
- **Documentation**: Update or add documentation as needed.
- **Tests**: Write tests for new features and bug fixes.

## Submitting Changes

1. **Create a Branch**: Use a descriptive name for your branch.

```bash
git checkout -b feature/your-feature-name
```

2. **Make Your Changes**: Ensure code is clean and well-documented.
3. **Test Your Changes**: Verify that everything works as expected.
4. **Commit and Push**:

```bash
git add .
git commit -m "Brief description of changes"
git push origin feature/your-feature-name
```

5. **Open a Pull Request**: Go to the repository and open a PR against the develop branch.

Your contributions make Capture better for everyone. We appreciate your time and effort!
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,18 @@ Our API is documented in accordance with the OpenAPI spec.

You can find the OpenAPI specifications [here](https://github.com/bluewave-labs/capture/blob/develop/openapi.yml)

## Contributing

We welcome contributions! If you would like to contribute, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information.

<a href="https://github.com/bluewave-labs/capture/graphs/contributors">
<img alt=""src="https://contrib.rocks/image?repo=bluewave-labs/capture" />
</a>

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=bluewave-labs/capture&type=Date)](https://www.star-history.com/#bluewave-labs/capture&Date)

## License

Capture is licensed under AGPLv3. You can find the license [here](./LICENSE)
Loading