diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9483225..d7a11ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,12 +2,14 @@ ## Checklist For Creating New Pull Requests +The following points should be considered before creating a new PR to the Sophia compiler. + ### Documentation - Update [Changelog](CHANGELOG.md) for all PRs. - If the PR introduces a new feature that is relevant to the users of the language, the [Sophia Features Documentation](docs/sophia_features.md) should be updated to describe the new feature. - If the PR introduces new syntax (e.g. changes in [aeso_syntax.erl](src/aeso_syntax.erl), [aeso_scan.erl](src/aeso_scan.erl), or [aeso_parser.erl](src/aeso_parser.erl)), the [Sophia Syntax Documentation](docs/sophia_syntax.md) should be updated to include the new syntax. -- If the PR introduces a new library, the new library's public interface should be fully documented in the [Sophia Standard Library Documentation](docs/sophia_stdlib.md). +- If the PR introduces a new library, the public interface of the new library should be fully documented in the [Sophia Standard Library Documentation](docs/sophia_stdlib.md). ### Tests