aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.github/workflows/mirror.yml18
-rw-r--r--CONTRIBUTING39
2 files changed, 39 insertions, 18 deletions
diff --git a/.github/workflows/mirror.yml b/.github/workflows/mirror.yml
deleted file mode 100644
index 0884624..0000000
--- a/.github/workflows/mirror.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-name: Mirror to ARFNET
-
-on: [push]
-
-env:
- REMOTE_REPO: arfnet2-lists
- REMOTE_SERVER: git.arf20.com
-
-jobs:
- push-mirror:
- runs-on: ubuntu-latest
- steps:
- - name: Clone repo
- run: git clone https://github.com/${{ github.repository }}
-
- - name: Push to remote repo
- run: cd $REMOTE_REPO && git push -u https://${{ secrets.MIRROR_USER }}:${{ secrets.MIRROR_PASSWORD }}@$REMOTE_SERVER/$REMOTE_REPO master
-
diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..e5fcac2
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,39 @@
+Contributing
+============
+
+We gracefully accept bug reports and contributions from the community.
+However there are some requirements and mechanisms that we expect
+contributors to follow.
+
+Coding Standards
+----------------
+- The code should follow the ARFNET conding style, but improving on it is
+ possible.
+- The code should be written in a clean and readable style.
+- The code must be portable, generic and compatible with updated systems.
+- The code should be as secure, reviewed and tested as much as possible from a
+ security point of view.
+
+Breaking Changes
+----------------
+Breaking changes need to be justified, and will be discussed on the
+mailing list.
+In case of a breaking changes, post a patch draft with --rfc
+
+Making a Contribution
+---------------------
+1. Use git to register your development process.
+2. git-rebase large amounts of small commits.
+3. Use git format-patch to generate a patchset, be sure to have your
+ git config updated and correct.
+4. Email it to the development@xxxxxxxxx mailing list,
+ indicating "PATCH arfnet2-lists" with --subject-prefix,
+ using git send-email. Include a patch comment with --compose.
+
+Then the appropiate maintainer will review the code for problems, and if checks
+OK, the maintainer will apply the patch on the development branch.
+Otherwise, the maintainer might request changes or reject the patch.
+Status of your contribution and followups will be posted in the mailing list.
+
+The maintainer for this project is arf20 <arf20@arf20.com>.
+