@@ -22,9 +22,9 @@ You can follow the workflow described below.
2222## How to Get Started With Development
2323
2424To contribute to F3D as a developer, first you may want to try and build F3D for yourself.
25- If you are already familiar with software compilation, you can take a look at our [ build guide] ( doc/dev/BUILD ) .
26- If not, you may want to look at our [ getting started guide] ( doc/dev/GETTING_STARTED ) , that provide steps to compile F3D.
27- You may also want to take a look into the [ F3D mentoring program] ( doc/dev/MENTORING ) in order to get help with all the
25+ If you are already familiar with software compilation, you can take a look at our [ build guide] ( doc/dev/04- BUILD ) .
26+ If not, you may want to look at our [ getting started guide] ( doc/dev/03- GETTING_STARTED ) , that provide steps to compile F3D.
27+ You may also want to take a look into the [ F3D mentoring program] ( doc/dev/12- MENTORING ) in order to get help with all the
2828contributing steps.
2929
3030Once you are able to build F3D, you may want to take a look at the open [ issues] ( https://github.com/f3d-app/f3d/issues ) !
@@ -33,11 +33,11 @@ If you already have some experience with programming and contribution, definitel
3333If an issue is interesting to you and is not yet assigned, then you should _ comment on the issue_ and ask for any help or clarification needed.
3434F3D maintainers will see your comment, assign the issue to you and provide guidance as needed.
3535
36- To get involved more deeply, please take a look at the [ roadmaps] ( doc/dev/ROADMAPS_AND_RELEASES ) for the upcoming releases.
36+ To get involved more deeply, please take a look at the [ roadmaps] ( doc/dev/09- ROADMAPS_AND_RELEASES ) for the upcoming releases.
3737
3838It is also recommended to reach out on [ Discord] ( https://discord.f3d.app ) to simplify communication, but it is not required.
3939
40- You may also want to understand the overall [ architecture] ( doc/dev/ARCHITECTURE ) of the F3D project.
40+ You may also want to understand the overall [ architecture] ( doc/dev/07- ARCHITECTURE ) of the F3D project.
4141
4242You can then fix the issue or implement the feature on your side and contribute it to the F3D repository by following the workflow described below.
4343
@@ -75,10 +75,10 @@ After this, the CI will always be run every time you push to your branch.
7575To remove a label, use the same syntax with a ` - ` before the label, eg: ` \ci -fast ` .
7676
7777F3D continuous integration will also check the coverage as it is a good way to evaluate if new features are being tested or not.
78- When adding code to F3D, always try to cover it by adding/modifying [ tests] ( doc/dev/TESTING ) .
78+ When adding code to F3D, always try to cover it by adding/modifying [ tests] ( doc/dev/05- TESTING ) .
7979
8080F3D continuous integration also checks formatting using clang-format and other tools and will inform you if changes needs to be made.
81- Some [ formatting rules] ( doc/dev/CODING_STYLE ) are not enforced by clang-format and will be checked during the review process.
81+ Some [ formatting rules] ( doc/dev/08- CODING_STYLE ) are not enforced by clang-format and will be checked during the review process.
8282
8383When making changes to the ` libf3d ` public API, continuous integration will warn about making related changes to the bindings.
8484This is required in order to merge the pull request.
0 commit comments