Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
135 lines (90 loc) · 6.75 KB

CONTRIBUTING.md

File metadata and controls

135 lines (90 loc) · 6.75 KB

Contributing guide

Want to contribute? Great!

We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, examples... But first, read this page (including the small print at the end).

Coding Philosophy

Writing a runtime is a big challenge. We want Chicory to always be a solid foundation for running Wasm in Java. In order to accomplish this, it's going to take a large team of diverse contributors. That's why our goal up front is to aim for writing simple code that's easy to understand and is as backwards compatible as possible.

The reason is we want to optimize for:

  • attracting more contributors
  • supporting more users
  • supporting more platforms

It's important we focus on this in the beginning phase so that we can grow a large team of contributors. We also want to make it possible for people with deep Wasm and runtime experience, but maybe not the deepest Java experience, to contribute.

This philosophy tends to lead us down what might seem like some non-optimal paths. We may ask you to simplify things, use older versions of Java, or reject improvements that we feel makes things more confusing without enough measurable benefits.

We don't expect to be able to maintain this forever, and some parts of the codebase will inevitably suffer from necessary complexity in the name of correctness, safety, or speed. But we are holding the line as long as we can.

Before you contribute

To contribute, use GitHub Pull Requests, from your own fork.

Also, make sure you have set up your Git authorship correctly:

git config --global user.name "Your Full Name"
git config --global user.email your.email@example.com

If you use different computers to contribute, please make sure the name is the same on all your computers.

We may use this information to acknowledge your contributions!

Code reviews

All submissions, including submissions by project members, need to be reviewed and approved by at least one project owner before being merged.

GitHub Pull Request Review Process is followed for every pull request.

Coding Guidelines

  • We primarily use the Git history to track authorship. GitHub also has this nice page with your contributions.
  • Please take care to write code that fits with existing code styles. The syntactic formatting is automated and can be applied project wise using the command mvn spotless:apply.
  • Commits should be atomic and semantic. Please properly squash your pull requests before submitting them. Fixup commits can be used temporarily during the review process but things should be squashed at the end to have meaningful commits.
  • We typically squash and merge pull requests when they are approved. This tends to keep the commit history a little bit more tidy without placing undue burden on the developers.

Building the Runtime

Contributors and other advanced users may want to build the runtime from source. To do so, you'll need to use Java and Maven:

  • Java version 11+ is required for a proper build. You can download and install Java 11 Temurin
  • You need Maven. If you don't have Maven installed, replace mvn in the below commands with ./mvnw (Linux/Mac) or ./mvnw.cmd (Windows).

Basic steps:

  • mvn clean install to run all of the project's tests and install the library in your local repo
  • mvn -Dquickly to install the library skipping all tests
  • mvn -Ddev <...goals> to disable linters and enforcers during development
  • mvn spotless:apply to autoformat the code
  • ./scripts/compile-resources.sh will recompile and regenerate the resources/compiled folders

note: if you're working using a corporate proxy (or anything like this), you might need to pass the usual -Dhttps.proxyHost=... and -Dhttps.proxyPort=... in order to properly instruct Maven about this (this can be required for example for test-gen-plugin since it downloads the testsuite).

Proposals implementation

Our priority is to focus on implementing proposals that are in the most advanced stages of development. While we wholeheartedly encourage and support explorations, we’ll be dedicating less time to early-stage proposals until we have more comprehensive support for those that are stabilized.

Continuous Integration

Because we are all humans, and to ensure Chicory evolves in the right direction, all changes must pass continuous integration before being merged. The CI is based on GitHub Actions, which means that pull requests will receive automatic feedback. Please watch out for the results of these workflows to see if your PR passes all tests.

IntelliJ default limits

Some of the SIMD tests are exceeding the default limits of IntelliJ. To overcome this issue go to "Help menu" -> "Edit Custom Properties" and add the following line:

idea.max.intellisense.filesize=5000

Wildcard imports

In this project, we disallow wildcard imports, when using IntelliJ we suggest to apply this configuration.

Tests and documentation are not optional

Don't forget to include tests in your pull requests. Also don't forget the documentation (reference documentation, javadoc...).

To automatically apply and approve e new version of the "Golden samples" used by the Approval tests you can use the environment variable:

APPROVAL_TESTS_USE_REPORTER=AutoApproveReporter

Reporting an issue

This project uses GitHub issues to manage the issues. Open an issue directly in GitHub.

If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing and what you would expect to see.

Legal

All original contributions to Chicory projects are licensed under the ASL - Apache License, version 2.0 or later, or, if another license is specified as governing the file or directory being modified, such other license.

The small print

This project is an open source project. Please act responsibly, be nice, polite and enjoy!