From patchwork Tue Mar 8 11:18:24 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonatan Schlag X-Patchwork-Id: 5321 Return-Path: Received: from mail01.ipfire.org (mail01.haj.ipfire.org [172.28.1.202]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384) client-signature ECDSA (P-384)) (Client CN "mail01.haj.ipfire.org", Issuer "R3" (verified OK)) by web04.haj.ipfire.org (Postfix) with ESMTPS id 4KCXrb03wQz3xj2 for ; Tue, 8 Mar 2022 11:18:38 +0000 (UTC) Received: from mail02.haj.ipfire.org (mail02.haj.ipfire.org [172.28.1.201]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384) client-signature ECDSA (P-384)) (Client CN "mail02.haj.ipfire.org", Issuer "R3" (verified OK)) by mail01.ipfire.org (Postfix) with ESMTPS id 4KCXrX3qMnz1Y2; Tue, 8 Mar 2022 11:18:36 +0000 (UTC) Received: from mail02.haj.ipfire.org (localhost [127.0.0.1]) by mail02.haj.ipfire.org (Postfix) with ESMTP id 4KCXrX31VPz2yqn; Tue, 8 Mar 2022 11:18:36 +0000 (UTC) Received: from mail01.ipfire.org (mail01.haj.ipfire.org [172.28.1.202]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384) client-signature ECDSA (P-384)) (Client CN "mail01.haj.ipfire.org", Issuer "R3" (verified OK)) by mail02.haj.ipfire.org (Postfix) with ESMTPS id 4KCXrV72l2z2xxL for ; Tue, 8 Mar 2022 11:18:34 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384) server-digest SHA384) (No client certificate requested) by mail01.ipfire.org (Postfix) with ESMTPSA id 4KCXrV3Y72z18B; Tue, 8 Mar 2022 11:18:34 +0000 (UTC) DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=ipfire.org; s=202003ed25519; t=1646738314; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=ZLopHArCbNwBJwiE57o4xQ8kA8/iblfiSShjIt+cIiQ=; b=LLRYWZ8NftSFqGR/3Lac5GK8NJTqhzHc18KL/CKJ0hJ7mDnyFfMLtV4FymSyyj6kD1We1d NQMkHFAbV7GfhLDA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ipfire.org; s=202003rsa; t=1646738314; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=ZLopHArCbNwBJwiE57o4xQ8kA8/iblfiSShjIt+cIiQ=; b=k0qGLkwDjDxRTpUvacKBWRmgTYrA0jtHUCJgec/DuSfTkOYqatKh0vb6OY8UkjoKymdN5X QYpbbEc+eWb8WS7P1RBWPgobQdB/XrDvAo3aTzr4gFIs6J4k4bU8M98FRY398MR1+ZoDU0 6TZY74ZpYEKNJkH6n2yJ9V0t47UsabqpeAC/UOscLqZKTjN9nyjpZlzx4XNG4KjwAJ5iBA VNl2h4+Ou/SiNrI2ZPKi07HBX7vZBRHE+Wc8+AvyNxTU+tZVcE1ieHY8XAfbiYjBa1Gb5N FPjA5ExnXZgQtxYNF9oszsSrWye6BBXpwp3Ir5dylrSYAZJlSb4Rx4PajaPedQ== From: Jonatan Schlag To: development@lists.ipfire.org Subject: [PATCH] Add Readme and Contributing guidelines. Date: Tue, 8 Mar 2022 12:18:24 +0100 Message-Id: <20220308111824.4967-1-jonatan.schlag@ipfire.org> MIME-Version: 1.0 X-BeenThere: development@lists.ipfire.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: IPFire development talk List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: development-bounces@lists.ipfire.org Sender: "Development" 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 --- README.md | 25 +++++++++++++++++++++++++ doc/CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 README.md create mode 100644 doc/CONTRIBUTING.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..1bb3a0727 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# IPFire + +# 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 which is used to build the whole distribution from scratch. + +# 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 options 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..510a26f02 --- /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) + + + +