diff --git a/doc/contributing.md b/doc/contributing.md new file mode 100644 index 000000000..95b62fb24 --- /dev/null +++ b/doc/contributing.md @@ -0,0 +1,10 @@ +# Contributing to ANTLR 4 + +1. [Fork](https://help.github.com/articles/fork-a-repo) the [antlr/antlr4 repo](https://github.com/antlr/antlr4) +2. Install and configure [EditorConfig](http://editorconfig.org/) so your text editor or IDE uses the ANTLR 4 coding style +3. [Build ANTLR 4](building-antlr.md) +4. [Run the ANTLR project unit tests](antlr-project-testing.md) +5. Create a [pull request](https://help.github.com/articles/using-pull-requests/) including your change + + +**Note:** You must sign the `contributors.txt` certificate of origin with your pull request if you've not done so before. diff --git a/doc/index.md b/doc/index.md index d5c55518e..cdd620dea 100644 --- a/doc/index.md +++ b/doc/index.md @@ -61,6 +61,8 @@ This documentation is a reference and summarizes grammar syntax and the key sema * [Building ANTLR itself](building-antlr.md) +* [Contributing to ANTLR](contributing.md) + * [Cutting an ANTLR Release](releasing-antlr.md) * [ANTLR project unit tests](antlr-project-testing.md)