summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcos <cos>2022-02-19 16:38:14 +0100
committercos <cos>2022-02-19 16:39:22 +0100
commit7a3567d3e4d71aa738b1b2061d7b1f09901fc2c4 (patch)
tree5238364281eeec9427d66b943ff28ace5afb21be
parent5b1044e2ade71fee4a59f94faa108d99b4e61fb2 (diff)
downloadale-7a3567d3e4d71aa738b1b2061d7b1f09901fc2c4.zip
Document the use of author rewriting toolsfeature/doc_contrib
-rw-r--r--doc/ale-development.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/ale-development.txt b/doc/ale-development.txt
index 3d0dd524..19a95954 100644
--- a/doc/ale-development.txt
+++ b/doc/ale-development.txt
@@ -14,6 +14,7 @@ CONTENTS *ale-development-contents*
4.1. Writing Linter Tests.............|ale-development-linter-tests|
4.2. Writing Fixer Tests..............|ale-development-fixer-tests|
4.3. Running Tests in a Windows VM....|ale-development-windows-tests|
+ 5. Contributing.........................|ale-development-contributing|
===============================================================================
1. Introduction *ale-development-introduction*
@@ -445,4 +446,22 @@ batch file, for example: `run-tests test/test_c_flag_parsing.vader` . This will
give you results much more quickly.
===============================================================================
+5. Contributing *ale-development-contributing*
+
+All integration of new code into ALE is done through GitHub pull requests.
+Using that tool streamlines the process and minimizes the time and effort
+required to e.g. ensure test suites are run for every change.
+
+As for any project hosted by GitHub, the choice of platform demands every
+contributor to take care to setup an account and configure it accordingly.
+
+Due to details of our process, a difference to many other GitHub hosted
+projects is that contributors who wish to keep the author fields for their
+commits unaltered need to configure a public email address in their account
+and profile settings. See: https://docs.github.com/en/account-and-profile/
+
+Unless configuring GitHub to expose contact details, commits will be rewritten
+to appear by `USERNAME <RANDOM_NUMBER+USERNAME@users.noreply.github.com>` .
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: