How to contribute to FerretDB
FerretDB is an open source project and everyone – developers and non-developers – is welcome to contribute. If you’re interested in contributing to FerretDB projects, this documentation will help you get started.
Here are some of the current FerretDB projects that you can fork and contribute to:
- FerretDB: This repository contains the FerretDB project – an open source alternative project to MongoDB.
- github-actions: This repository houses our shared GitHub Actions for FerretDB, dance, and other repositories.
- dance: This repository is a FerretDB integration testing tool.
For those taking their first steps in contributing to an open source project. Please take a look at this post on how to contribute to open source software.
You don’t have to be a developer to contribute to FerretDB projects, you can even get started by helping us improve this documentation. If you have any questions or suggestions on how we can improve, kindly join our Slack chat or GitHub discussions. We appreciate your feedback.
Contributing to this documentation
If you find anything confusing or missing in the documentation, click the “Edit this page” link at the bottom of almost every page in the documentation. More information on contributing to the documentation can be found here.
Contributing to the FerretDB repository
- To contribute to this FerretDB project, please read the CONTRIBUTING.md and CODE_OF_CONDUCT.md guideline to know more.
- Is everything working as it should? If not, please let us know by creating an issue. You can create issues for bugs, documentation, features, or enhancements.
- You can identify issues you would like to work on by looking at the open issues for this repository.
- The most straightforward way to start contributing to this repository is to select issues that are labeled good-first-issues
Contributing to dance
- To start contributing to the dance repository for integration testing, follow the guidelines in the CONTRIBUTING.md and CODE_OF_CONDUCT.md files.
- Looking for something to work on? Check out the open issues for this repository.