This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "IPFire 2.x development tree".

The branch, next has been updated via e6cbe7563f1e9e92b77c4d30aa76cbac27d71103 (commit) via a5a5857865daddaf5911f16260081d2b5d5e1c46 (commit) from 219a998412a7d9206126c534a7d227802262b0f6 (commit)

Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below.

- Log ----------------------------------------------------------------- commit e6cbe7563f1e9e92b77c4d30aa76cbac27d71103 Author: Peter Müller peter.mueller@ipfire.org Date: Mon Mar 21 13:47:58 2022 +0000

Improve README and CONTRIBUTING

- Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files

Signed-off-by: Peter Müller peter.mueller@ipfire.org

commit a5a5857865daddaf5911f16260081d2b5d5e1c46 Author: Jonatan Schlag jonatan.schlag@ipfire.org Date: Tue Mar 8 12:18:24 2022 +0100

Add Readme and Contributing guidelines.

For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction.

Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points:

First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently.

Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed.

Signed-off-by: Jonatan Schlag jonatan.schlag@ipfire.org

-----------------------------------------------------------------------

Summary of changes: README.md | 29 +++++++++++++++++++++++++++++ doc/CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 README.md create mode 100644 doc/CONTRIBUTING.md

Difference in files: diff --git a/README.md b/README.md new file mode 100644 index 000000000..df3d35717 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# IPFire 2.x - The Open Source Firewall + +# What is IPFire? + +IPFire is a hardened, versatile, state-of-the-art Open Source firewall based on +Linux. Its ease of use, high performance in any scenario and extensibility make +it usable for everyone. For a full list of features have a look [here](https://www.ipfire.org/features). + +This repository contains the source code of IPFire 2.x which is used to build +the whole distribution from scratch, since IPFire is not based on any other +distribution. + +# Where can I get IPFire? + +Just head over to https://www.ipfire.org/download + +# How do I use this software? + +We have a long and detailed wiki located [here](https://wiki.ipfire.org/) which +should answers most of your questions. + +# But I have some questions left. Where can I get support? + +You can ask your question at our community located [here](https://community.ipfire.org/). +A complete list of our support channels can be found [here](https://www.ipfire.org/support). + +# How can I contribute? + +We have another document for this. Please look [here](doc/CONTRIBUTING.md). diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md new file mode 100644 index 000000000..3680130b1 --- /dev/null +++ b/doc/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# 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 of the most important topics. + +### Contact + +We use the 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, accessible at `git.ipfire.org`. The +GitHub repositories are **only** mirrors of `git.ipfire.org`, available as a courtesy +to the internet community. + +### 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. + +### Reporting 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 + +Unfortunately, we do not accept GitHub pull requests. Instead, 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). + + + +

hooks/post-receive -- IPFire 2.x development tree