Skip to content
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

Add contribution guide #8

Merged
merged 1 commit into from
Nov 17, 2024
Merged
Show file tree
Hide file tree
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
83 changes: 83 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Contribution Guide

We appreciate your interest in contributing! Here’s how you can get involved.

## 🐞 Reporting Issues

### Security Vulnerabilities

If you discover a security issue, please report it promptly via the GitHub ["Report a Vulnerability"][new-security] tab.
For more details on our security policies, see [SECURITY.md](SECURITY.md).

### Bugs

Found a bug?
Before opening a new issue, please check the [existing issues][issues] to see if it’s already been reported.
If it’s a new bug, you can [create an issue here][new-issue].

### Feature Requests

Got an idea for a new feature? We’d love to hear it!
Please [submit a feature request][new-issue] and provide as much detail as possible.

## 🛠️ Contributing Code

If you’d like to contribute code, follow these steps:

1. **Open an Issue:** Start by [opening an issue][new-issue] to discuss your proposal or bug fix.
2. **Fork the Repository:** Create a fork and work on your changes in a new branch.
3. **Submit a Pull Request:** Once your changes are ready, submit a Pull Request (PR) for review.

## 💻 Development Setup

To set up your development environment, ensure you have the following tools installed:

- Go
- Make
- Docker

## 🧪 Testing

### Writing Tests

All new code must include unit tests to ensure coverage and stability.

### Running Tests

Run the tests locally with:

```bash
make test
```

## 🔍 Code Quality

### Linting

Ensure your code meets project standards by running the linter:

```bash
make lint
```

## 🐳 Using Docker for Development

You can use the Docker development environment included in the project.
To start a shell session inside the container, use:

```bash
make bash
```

## 📋 Makefile Commands

To see a list of available `make` commands, run:

```bash
make help
```


[issues]: https://github.com/nebius/gosdk/issues
[new-issue]: https://github.com/nebius/gosdk/issues/new/choose
[new-security]: https://github.com/nebius/gosdk/security/advisories/new
11 changes: 11 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Reporting Security Issues

The Nebius team take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.

To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/nebius/gosdk/security/advisories/new) tab.

The Nebius team will send a response indicating the next steps in handling your report. After the initial reply to your report, the Nebius team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.

## Learning More About Security in Nebius

To learn more about security in Nebius, please see [this page](https://nebius.ai/docs/security).
Loading