Nothing Special   »   [go: up one dir, main page]
Skip to content

Latest commit

 

History

History
92 lines (67 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

92 lines (67 loc) · 4.46 KB
Raw

Guidelines for contributing to Janet

Thanks for taking time to contribute to Janet!

Please read this document before making contributions.

Reporting bugs

  • Check past and current issues to see if your problem has been run into before.
  • If you can't find a past issue for your problem, or if the issues has been closed you should open a new issue. If there is a closed issue that is relevant, make sure to reference it.
  • As with any project, include a comprehensive description of the problem and instructions on how to reproduce it. If it is a compiler or language bug, please try to include a minimal example. This means don't post all 200 lines of code from your project, but spend some time distilling the problem to just the relevant code.

Contributing Changes

If you want to contribute some code to the project, please submit a pull request and follow the below guidelines. Not all changes will be merged, and some pull requests may require changes before being merged.

  • Include a description of the changes.

  • If there are changes to the compiler or the language, please include tests in the test folder. The test suites are not organized in any particular way now, so simply add your tests to one of the test suite files (test/suite0.janet, test/suite1.janet, etc.). You can run tests with make test. If you want to add a new test suite, simply add a file to the test folder and make sure it is run whenmake test is invoked.

  • Be consistent with the style. For C this means follow the indentation and style in other files (files have MIT license at top, 4 spaces indentation, no trailing whitespace, cuddled brackets, etc.) Use make format to automatically format your C code with astyle. You will probably need to install this, but it can be installed with most package managers.

    For janet code, use lisp indentation with 2 spaces. One can use janet.vim to do this indentation, or approximate as close as possible. There is a janet formatter in spork that can be used to format code as well.

C style

For changes to the VM and Core code, you will probably need to know C. Janet is programmed with a subset of C99 that works with Microsoft Visual C++. This means most of C99 but with the following omissions.

  • No restrict
  • Certain functions in the standard library are not always available

In practice, this means programming for both MSVC on one hand and everything else on the other. The code must also build with emscripten, even if some features are not available, although this is not a priority.

Code should compile warning free and run valgrind clean. I find that these two criteria are some of the easiest ways to protect against a large number of bugs in an unsafe language like C. To check for valgrind errors, run make valtest and check the output for undefined or flagged behavior.

Formatting

Use astyle via make format to ensure a consistent code style for C.

Janet style

All janet code in the project should be formatted similar to the code in core.janet. The auto formatting from janet.vim will work well.

Typo Fixing and One-Line changes

Typo fixes are welcome, as are simple one line fixes. Do not open many separate pull requests for each individual typo fix. This is incredibly annoying to deal with as someone needs to review each PR, run CI, and merge. Instead, accumulate batches of typo fixes into a single PR. If there are objections to specific changes, these can be addressed in the review process before the final merge, if the changes are accepted.

Similarly, low effort and bad faith changes are annoying to developers and such issues may be closed immediately without response.

Contributions from Automated Tools

People making changes found or generated by automated tools MUST note this when opening an issue or creating a pull request. This can help give context to developers if the change/issue is confusing or nonsensical.

Suggesting Changes

To suggest changes, open an issue on GitHub. Check GitHub for other issues that may be related to your issue before opening a new suggestion. Suggestions put forth without code will be considered, but not necessarily implemented in any timely manner. In short, if you want extra functionality now, then build it.

  • Include a good description of the problem that is being solved
  • Include descriptions of potential solutions if you have some in mind.