Add the contributing guide - #79
Merged
Merged
Conversation
Build, test, the FreeBSD VM, and one recipe per kind of change (a NIF, an erlang.* function, a context option, a suite, a guide) listing every file that change touches, so a contributor can finish a change without reading the whole tree first.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The knowledge of how to build and test this project, and of which files a change has to touch to be complete, lived in CI scripts and in habit. This page writes it down: the build and its knobs, the test commands including the free-threaded and ASan variants CI runs, a way to get a FreeBSD VM for the isolated mode, and five recipes for the changes that come up most (a NIF, an
erlang.*function with its three implementations, a context option in both modes, a suite, a guide), each ending with the same tests-dialyzer-changelog steps, followed by the pull request checklist.