[people/pmueller/ipfire-2.x.git] / doc / CONTRIBUTING.md

# 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)
Commit	Line	Data
a5a58578 JS	1	# How can I help?
	2
	3	You can help in numerous ways. This document should give you an overview of what is possible and how you can get involved.
	4	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/).
	5	Instead, it should guide you to the right places to look for further information.
	6
	7	## Development
	8
	9	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.
	10
	11	### Contact
	12
	13	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)
	14
	15	### Source Code
	16
	17	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.
	18
	19	### How to build the distribution?
	20
	21	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.
	22
	23	### Bugs
	24
	25	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).
	26	We do not use GitHub for tracking bugs.
	27
	28	### Contribute changes to the source code
	29
	30	First: we do not accept GitHub pull requests! We are working with patches which are sent to our mailing list development@lists.ipfire.org .
	31	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)
	32
	33
	34
	35