There are many ways you can contribute beyond coding. For example, you can report problems, clarify [issues](https://github.com/digital-asset/daml/issues), and write documentation. If you're completely new to open source development, the [Open Source Guides](https://opensource.guide) is a great place to start.
This project and everyone participating in it is governed by the [DAML Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [community@digitalasset.com](mailto:community@digitalasset.com).
## Git conventions
For Git commit messages, our principle is that `git log --pretty=oneline` should give readers a clear idea of what has changed and the detailed descriptions should help them understand the rationale. To achieve this:
* Commits must have a concise, imperative title, e.g.:
* *Fix performance regression in …*
* *Improve explanation of …*
* *Remove module X because it is not used.*
* Commits should have a description that concisely explains the rationale and context for the change if that is not obvious.
* Make sure your PR title and description makes it easy for other developers to understand what the contained commits do. The title should say what the changes do. The description should expand on what it does (if not obvious from the title alone), and say why it is being done.
* If your PR corresponds to an issue, add “Fixes #XX” to your pull request description. This will auto-close the corresponding issue when the commit is merged into master and tie the PR to the issue.
* the squashed commit for the PR **MUST** include in its body a section between the ``CHANGELOG_BEGIN`` and ``CHANGELOG_END`` tags. This section **MAY** include a list of _user-facing_ changes [Follow these guidelines on how to write a good changelog entry](#writing-a-good-changelog-entry).
If you want to verify the changelog entries as described by a range of Git revisions, you can use the `unreleased.sh` script. In most cases, to see the entries added as part of commits added since branching off of `master`, you can run:
Writing good changelog entries is **important**: as a developer, it gives visibility on your contribution; as a user, it makes clear what is new, what's changed, and how to deal with them, making the product more accessible and your work more meaningful.
The raw changelog is used to compile a meaningful summary of changes across releases. This happens some time after the PR has been merged and the person taking the responsibility of summarizing new user-facing features must be in the position to easily understand the nature of the change and report it. The ideal changelog entry can be more or less incorporated verbatim in the release notes.
Here are a few practical tips:
* if there are no user-facing changes, keep the changelog entry list empty
* the first term to appear should be the affected component -- [here's a list](#list-of-components-for-changelog-entries)
* write as many changelog entries as necessary
* don't be _too_ succinct: a single entry does **not have to** fit on a single line
* on the other end, if the size grows beyond 5-6 lines, rather add a link to a relevant documentation or issue with more details
* the ultimate target are end users: focus on the impact on them, tell them what's new or how to deal with a change
### List of components for changelog entries
This list should cover the vast majority of needs. If unsure, ask on the relevant GitHub issue or PR.
* DAML Compiler
* DAML on SQL
* DAML Studio
* Distribution/Releases
* Extractor
* Java Bindings
* Java Codegen
* JavaScript Client Libraries
* JavaScript Codegen
* JSON API
* Ledger API Specification
* Integration Kit †
* Navigator
* DAML REPL
* Sandbox
* Scala Bindings
* Scala Codegen
* DAML Script
* DAML Assistant
* DAML Standard Library
* DAML Triggers
† Covers the Ledger API Test Tool and changes to libraries that affect ledger integrations (e.g. `kvutils`)
We use issues and [pull requests](https://help.github.com/articles/about-pull-requests/) to collaborate and track our work. Anyone is welcome to open an issue. If you just want to ask a question, please ask away on [the DAML forum](https://discuss.daml.com).
We encourage everyone to vote on issues that they support or not:
* 👍 - upvote
* 👎 - downvote
When you start working on an issue, we encourage you to tell others about it in an issue comment. If other contributors know that this issue is already being worked on, they might decide to tackle another issue instead.
When you add `TODO` (nice to have) and `FIXME` (should fix) comments in the code, we encourage you to create a corresponding issue and reference it as follows:
*`TODO(#XX): <description>` where `#XX` corresponds to the GitHub issue.
*`FIXME(#XX): <description>` where `#XX` corresponds to the GitHub issue.
### Labels
We use labels to indicate what component the issue relates to (`component/...`). We use some special labels:
-`broken` to indicate that something in the repo is seriously broken and needs to be fixed.
-`discussion` to indicate the issue is to discuss and decide on something.
-`good-first-issue` to indicate that the issue is suitable for those who want to contribute but don't know where to start.
By default, issues represent "work to be done" -- that might be features, improvements, non-critical bug fixes, and so on.
The DAML Language team uses labels to indicate priority (the DAML Runtime team does not):
In addition to labels, we group issues into *milestones*. The DAML Language team has all issues in a single *Language* milestone; the DAML Runtime team uses them to group work efforts (*Add PostgreSQL backend to the Ledger* for example). *Maintenance* and *Backlog* are special milestones.
Issues without a milestone are treated as in need of triaging.
Please hold discussions that are relevant to DAML development and not confidential in GitHub issues. That way, anyone who wants to contribute or follow along can do so. If you have private discussions, please summarise them in an issue or comment to an issue.
You can also join a `#daml-contributors` channel on our Slack: [damldriven.slack.com](https://damldriven.slack.com/sso/saml/start).
