diff --git a/doc/source/contributor-ref-good-first-contributions.rst b/doc/source/contributor-ref-good-first-contributions.rst index 41fa196fb081..957758f0f242 100644 --- a/doc/source/contributor-ref-good-first-contributions.rst +++ b/doc/source/contributor-ref-good-first-contributions.rst @@ -1,40 +1,47 @@ Good first contributions ======================== -We welcome contributions to Flower! However, it is not always easy to know -where to start. We therefore put together a few recommendations on where to -start to increase your chances of getting your PR accepted into the Flower -codebase. - +We welcome contributions to Flower! However, it is not always easy to know where to +start. We therefore put together a few recommendations on where to start to increase +your chances of getting your PR accepted into the Flower codebase. Where to start -------------- -Until the Flower core library matures it will be easier to get PR's accepted if -they only touch non-core areas of the codebase. Good candidates to get started -are: - -- Documentation: What's missing? What could be expressed more clearly? Are there any typos? You can also check-out our `contributing guide for translations `_. -- Strategies: Are there any strategies you'd like to use but isn't implemented yet? Take a look at existing strategies like `FedAvg `_ to better understand how they work and check-out our `strategy implementation guide `_ for further information. +Until the Flower core library matures it will be easier to get PR's accepted if they +only touch non-core areas of the codebase. Good candidates to get started are: + +- Documentation: What's missing? What could be expressed more clearly? Are there any + typos? You can also check-out our `contributing guide for translations + `_. +- Strategies: Are there any strategies you'd like to use but isn't implemented yet? Take + a look at existing strategies like `FedAvg + `_ to + better understand how they work and check-out our `strategy implementation guide + `_ for further + information. - Baselines: See below. - Examples: See below. - Request for Flower Baselines ---------------------------- -If you are not familiar with Flower Baselines, you should probably check-out our `contributing guide for baselines `_. +If you are not familiar with Flower Baselines, you should probably check-out our +`contributing guide for baselines +`_. -You should then check out the open -`issues `_ for baseline requests. -If you find a baseline that you'd like to work on and that has no assignees, feel free to assign it to yourself and start working on it! +You should then check out the open `issues +`_ +for baseline requests. If you find a baseline that you'd like to work on and that has no +assignees, feel free to assign it to yourself and start working on it! -Otherwise, if you don't find a baseline you'd like to work on, be sure to open a new issue with the baseline request template! +Otherwise, if you don't find a baseline you'd like to work on, be sure to open a new +issue with the baseline request template! Request for examples -------------------- -We wish we had more time to write usage examples because we believe they help -users to get started with building what they want to build. You can either open a -PR if your project is self contained and in a good shape, or otherwise share it -on the `Flower Discuss forum`_! +We wish we had more time to write usage examples because we believe they help users to +get started with building what they want to build. You can either open a PR if your +project is self contained and in a good shape, or otherwise share it on the `Flower +Discuss forum`_!