-
Notifications
You must be signed in to change notification settings - Fork 390
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation for contributors (#1194)
Closes #1164.
- Loading branch information
Showing
1 changed file
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# 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](https://github.com/FerretDB/FerretDB): This repository contains the FerretDB project – an open source alternative project to MongoDB. | ||
* [github-actions](https://github.com/FerretDB/github-actions): This repository houses our shared GitHub Actions for FerretDB, dance, and other repositories. | ||
* [dance](https://github.com/FerretDB/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](https://www.ferretdb.io/how-to-contribute-to-open-source-2022/). | ||
|
||
## Get Started | ||
|
||
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](/intro/#community) or [GitHub discussions](https://github.com/FerretDB/FerretDB/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](https://github.com/FerretDB/FerretDB/blob/main/CONTRIBUTING.md#contributing-documentation). | ||
|
||
## Contributing to the FerretDB repository | ||
|
||
* To contribute to this [FerretDB project](https://github.com/FerretDB/FerretDB/), please read the [CONTRIBUTING.md](https://github.com/FerretDB/FerretDB/blob/main/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/FerretDB/FerretDB/blob/main/CODE_OF_CONDUCT.md) guideline to know more. | ||
* Is everything working as it should? | ||
If not, please let us know by [creating an issue](https://github.com/FerretDB/FerretDB/issues/new/choose). | ||
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](https://github.com/FerretDB/FerretDB/issues) for this repository. | ||
* The most straightforward way to start contributing to this repository is to select issues that are labeled [good-first-issues](https://github.com/FerretDB/FerretDB/contribute) | ||
|
||
## Contributing to dance | ||
|
||
* To start contributing to the [dance repository](https://github.com/FerretDB/github-actions) for integration testing, follow the guidelines in the [CONTRIBUTING.md](https://github.com/FerretDB/dance/blob/main/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/FerretDB/dance/blob/main/CODE_OF_CONDUCT.md) files. | ||
* Looking for something to work on? | ||
Check out the [open issues](https://github.com/FerretDB/dance/issues) for this repository. | ||
|
||
## Contributing to github-actions | ||
|
||
* To contribute to our [github-actions repository](https://github.com/FerretDB/github-actions/), please go through the instructions in the [CONTRIBUTING.md](https://github.com/FerretDB/github-actions/blob/main/CONTRIBUTING.md) file. |
6677714
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
ferret-db – ./
ferret-db.vercel.app
ferret-db-git-main-ferretdb.vercel.app
ferret-db-ferretdb.vercel.app