This repository hosts the source code for the Lingua Franca compiler, which is written in Java and Kotlin. We welcome contributions from the community and provide these guidelines in order to make contributing a smooth, efficient, and fun process.
GitHub Issues is the place to report bugs, request features, or document other issues that cannot be addressed immediately and need to be tracked over a longer period of time. We currently do not require any particular format for issues, but we do request that you properly label them to make it easier to manage them.
You can work on the Lingua Franca code base in your favorite editor and build using Gradle (recommended) or Maven. Please refer to our handbook for specific instructions for setting up a development environment in IntelliJ or Eclipse.
An integral part of contributing code is writing tests.
Unit tests for the compiler are located in the org.lflang.tests package and are implemented using the JUnit test framework. These tests are invoked using Gradle. For example, to run all the tests in the org.lflang.tests.compiler package, use the following command:
./gradlew test --tests org.lflang.tests.compiler.*
Integration tests consist of complete Lingua Franca programs that are located in the test directory in the root of the repository and are organized first by target, then by category. These tests get indexed automatically and are also invoked using Gradle. For instance, to run all the tests for the C target, use the following command:
./gradlew test --tests org.lflang.tests.runtime.CTest.*
Test categories are declared in the TestCategory enum in TestRegistry.java. Each .lf file is identified by the matching containing directory closest to it, or, if there is no such directory, it will be identified as generic. E.g., test/C/src/multiport/Foo.lf falls in the multiport category. Tests are normally expected to compile without errors and return exit code 0 when executed. Some test categories (e.g., arduino) are not attempted to run and are only expected to compile as they might require the presence of particular hardware or exotic software configurations that are not manageable in GitHub Actions, our current platform for Continuous Integration (CI). Only pushes to feature branches associated with an active pull request trigger CI.
All code contributions must go through a pull request (PR), pass all tests run in CI, and get an approving review before it is merged. Pushing to the master branch is restricted. All code review is conducted using the Github review system on PRs. Before requesting a code review, ensure that you have:
- applied the code formatter;
- documented your code;
- written tests that cover your code; and
- accompanied any remaining
TODOs orFIXMEs with a link to an active issue.
Develop new changes in a feature branch or in a fork (if you have no write permission on the repository). Please use an informative branch name and use kebab case (e.g., my-new-feature).
We currently do not adhere to strict rules regarding commit messages. We only ask that your commit messages are descriptive and informative.
When you file a PR, provide a clear and well-written description of the changes you are proposing. We use PRs to automatically construct our changelog and release notes; the text you write will be featured in them.
Please make sure that the title of your PR adheres to the following rules:
- Describe a contribution, not the activity of implementing it.
- Bad: "Improve reporting of file system errors"
- Good: "Improved reporting of file system errors"
- Bad: "Fixes #123"
- Good: "Fix for #123"
- Bad: "Optimizing algorithm x"
- Good: "Optimization of algorithm x"
- Start with a capital.
- Bad: "in a hurry"
- Good: "Hurried new feature"
- Do not use title case.
- Bad: "Amazing Fix of a Terrible Bug"
- Good: "Amazing fix of a terrible bug"
- Do not use a period at the end.
- Bad: "Titles are not sentences."
- Good: "Titles are not sentences"
Labels are used to organize our changelog and release notes. Please label your PR to make it as clear as possible from the labels what this PR is about. If, for whatever reason, your changes should not appear in these digests, you can mark it as such using the exclude label.
If a PR is not yet ready for review, mark it as Draft. Once it is ready for review, mark it Ready for Review.
Perform merges to bring your feature branch up-to-date with master locally (do not issue a PR). This is very easy to do.
- Ensure you are on your feature branch (run
git branchto find out;git switch my-feature-branchto switch to your feature branch). - Make sure you have the latest changes (run
git fetch --all) - Perform the merge (run
git merge origin/master, assuming that you want to merge the branchmasterfrom remoteoriginintoyour-feature-branch).
To address feedback from code review, implement changes and push to your feature branch. If you are certain that a reviewer's concern has been addressed by your new changes, hit the Resolve conversation button. If you are unsure, ask for follow up in the conversation and let the reviewer determine whether the feedback was addressed accordingly.
The Lingua Franca compiler is implemented in Java and Kotlin. The overarching advice is to use each language's most widely used idioms and conventions, which are fortunately very similar. The code base is shipped with a Spotless configuration to check and enforce style compliance. Lingua Franca code (e.g., tests) in this repository is also automatically formatted via Spotless.
- To check that modified files are formatted correctly, run:
./gradlew spotlessCheck
- To apply the changes recommended by the formatter, run:
./gradlew spotlessApply
- Do not copy-paste code. If you want to reuse code, factor it out into a method and call it.
- Keep methods concise. As a rule of thumb, a method should fit on your screen so that it can be read without scrolling. We impose no hard limit on method length, but anything above 40 lines should be considered for breaking up.
- Keep classes concise. Classes should be limited in scope and not become too large. Anything above 1000 lines probably needs refactoring.
- Do not leave FIXMEs. Unaddressed
FIXMEs should not be allowed to pass code review unless they are accompanied with a link to a GitHub issue.
Comments
Please adhere to the following principles when writing documentation for your code:
- Write descriptions in English.
- Do not use contractions like "aren't" or "isn't".
- Use imperative in the description of a method, i.e., write "Compute the shortest path," not "Computes the shortest path" (the latter is not a complete sentence).
- In
@paramJavaDoc tag descriptions it is OK to use incomplete sentences in the interest of brevity.
We use the Google Java style guide, which leaves a few things unspecified that we discuss here in a bit more depth.
Ordering of class contents (S3.4.2)
The order you choose for the members and initializers of your class can have a great effect on learnability. However, there's no single correct recipe for how to do it; different classes may order their contents in different ways.
What is important is that each class uses some logical order, which its maintainer could explain if asked. For example, new methods are not just habitually added to the end of the class, as that would yield "chronological by date added" ordering, which is not a logical ordering.
When in doubt, the following suggestions might help:
- Keep all fields at the very top (and sort them internally by visibility).
- After fields, declare constructors.
- After constructors, put all methods, in "some logical order".
- Put inner classes at the very end.
Visibility
Avoid public non-final fields and public collection fields (making them final does not make their contents immutable).
Inheritance
Design for inheritance or prohibit it. Make new classes final by default, and avoid using protected members. The class should only be unsealed if a use case for inheritance shows up, which is in many cases never. Often, composition can offer a better solution than inheritance (also see a blog post on this).
Collections
Use interfaces like List, Set, Map to type variables, constructor parameters, and method signatures, not concrete implementations like LinkedList, HashSet, or LinkedHashMap.
Collection mutability
In Java, instances of collection classes may be read-only. They will throw an exception when modification is attempted. Read-only views on collections are used to prevent external code from modifying an internal collection by accident, which may break class invariants. Encapsulating modifications to the collection into extra mutator methods is good practice, because it allows maintaining class invariants if the class evolves.
-
Assume that any list returned from a method of an object that you do not control is unmodifiable unless otherwise documented. That means, make a copy if you need a local modification.
-
If you return a collection which is a field of the current object, make it unmodifiable (i.e.,
return Collections.unmodifiableList(internalList);). If the API must return a modifiable list, then document that it is modifiable. (It's usually better to provide mutator methods to encapsulate the modification to the collection.)
/* Assume the returned list is unmodifiable */
List<String> contents = container.getListOfContents();
/* You can iterate on the list, get an item, but not set/add/remove. To make local modifications, make a copy:*/
contents = new ArrayList<>(contents);
/* Now the list is modifiable, but changes do not affect the `container` object */
contents.add("extra");
/* If you need to modify the internal list of the `container`, add a method to the container that encapsulates that logic */
container.add("extra");
JavaDoc
The Google style guide is pretty terse about JavaDoc, in particular about where JavaDoc is required. Please refer to the Oracle JavaDoc style guide for detailed guidelines.
Compact JavaDoc
Omit @param and @return tags from JavaDoc if the summary line already describes everything there is to know about them.
For instance, prefer:
/** Return the sum of a and b. */
public static int getSum(int a, int b) { ... }
over
/**
* Return the sum of two integers.
* @param a an integer
* @param b an integer
* @return the sum of both parameters
*/
public static void printSum(int a, int b) { ... }
Additional information about "compact style" JavaDoc can be found here.
Please follow the Kotlin coding conventions.
Code review can be challenging and time consuming, but it is critical for ensuring code quality. This document is meant as a resource for both contributors and reviewers as a reference that codifies in some detail what is expected of contributed code. Reviewers are expected to help contributors conform to the guidelines and help them improve the quality of their contributions. If you are reviewing code, please provide comments that are helpful, constructive, and encouraging.
Sometimes suggestions for improvement can creep beyond the original scope of the fix or feature that a PR means to introduce. In that case, it might be a better option to document suggestions for further improvement in an issue, allowing it to be carried out in a future PR (instead of holding up merging of the current PR).