X-Git-Url: http://git.ipfire.org/?p=people%2Fpmueller%2Fipfire-2.x.git;a=blobdiff_plain;f=doc%2FCONTRIBUTING.md;fp=doc%2FCONTRIBUTING.md;h=510a26f027b97c7a357cd4e1c38e80c860523d23;hp=0000000000000000000000000000000000000000;hb=a5a5857865daddaf5911f16260081d2b5d5e1c46;hpb=219a998412a7d9206126c534a7d227802262b0f6 diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md new file mode 100644 index 0000000000..510a26f027 --- /dev/null +++ b/doc/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# How can I help? + +You can help in numerous ways. This document should give you an overview of what is possible and how you can get involved. +It will **not** give you all information you need to successfully contribute to avoid content duplication between this document and our [wiki](https://wiki.ipfire.org/). +Instead, it should guide you to the right places to look for further information. + +## Development + +All information is available in the [development section](https://wiki.ipfire.org/devel) of our wiki. The following is a very short overview about the most important topics. + +### Contact + +We use a mailing list development@lists.ipfire.org for our communication. For the list archive and registration, see [here](http://lists.ipfire.org/mailman/listinfo/development) + +### Source Code + +We use our own infrastructure for code hosting, located under git.ipfire.org. The GitHub repositories are **only** mirrors of the main repositories located under git.ipfire.org. + +### How to build the distribution? + +In order to contribute, you certainly need to build the distribution at some point. See [here](https://wiki.ipfire.org/devel/ipfire-2-x/build-howto) for a long guide how to do that. + +### Bugs + +We have a bug tracker located [here](https://wiki.ipfire.org/devel/bugzilla). Further information can be found in our [wiki](https://wiki.ipfire.org/devel/bugzilla). +We do **not** use GitHub for tracking bugs. + +### Contribute changes to the source code + +First: **we do not accept GitHub pull requests!** We are working with patches which are sent to our mailing list development@lists.ipfire.org . +This process might be a bit tricky in the beginning. That's why you can find more information how to do this [here](https://wiki.ipfire.org/devel/submit-patches) + + + +