Add CONTRIBUTING.md #897

Merged
ghallak merged 13 commits from ghallak/contributing into master 2022-08-05 00:35:48 +09:00
Showing only changes of commit cbd0ba18fc - Show all commits

View File

@ -5,9 +5,9 @@
### Documentation ### Documentation
- Update [Changelog](CHANGELOG.md) for all PRs. - 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](doc/sophia_features.md) should be updated to describe the new feature. - 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](doc/sophia_syntax.md) should be updated to include the new syntax. - 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](doc/sophia_stdlib.md). - 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).
### Tests ### Tests