Skip to content

Commit

Permalink
Update the contribution document (#4364)
Browse files Browse the repository at this point in the history
* Update the contribution document

* updated changelog example
  • Loading branch information
fealebenpae authored Feb 8, 2021
1 parent 202cc6c commit 89af877
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@ When filing an issue, please provide as much of the following information as pos

We love contributions to Realm! If you'd like to contribute code, documentation, or any other improvements, please [file a Pull Request](https://github.com/realm/realm-core/pulls) on our GitHub repository. Make sure to accept our [CLA](#cla) and to follow our [style guide](doc/development/coding_style_guide.cpp).

### Branches

Most changes should always go in the `master` branch - this means bugfixes, small enhancements, and features that do not introduce "behavior-breaking" changes. The exception is any code that touches the file format or sync protocol, as well as non-trivial changes to APIs - those should target the `breaking` branch. When in doubt please get in touch with the [Core Database team](https://github.com/orgs/realm/teams/core-database).
Occasionally a single PR, while a complete unit of work, does not contain everything needed to make a release. For example, adding a new data type involves work in the storage, query, schema, and sync layers which is usually shared by several contributors. In this case we use a feature integration branch. The current integration branch and its theme are announced with a pinned topic in [Discussions](https://github.com/realm/realm-core/discussions).

### Changelog

Pull requests that touch code should always add an entry to `CHANGELOG.md` with a sentence or two describing a change and a link to the relevant issue or the PR itself. The expectation is that the entry gives a general idea about the change, and then the PR or issue describes the nature of the change in more detail. Bug fixes should also mention the version the bug was introduced in.
Changelog entries should be high-level enough that they make sense when viewed by users of the Realm SDKs. A good example is
```
* Fixed an issue where opening a realm from two different processes on Windows results in a deadlock ([#9999](https://github.com/realm/realm-core/issues/9999), since vX.Y.Z)
```
instead of `Fixed a bug with signaling win32 robust mutexes`. The nature of the change should be discussed in the PR or issue whereas the changelog entry describes the visible outcome to users. For anything else please use the `Internals` section of `CHANGELOG.md`.

### Commit Messages

Although we don’t enforce a strict format for commit messages, we prefer that you follow the guidelines below, which are common among open source projects. Following these guidelines helps with the review process, searching commit logs and documentation of implementation details. At a high level, the contents of the commit message should convey the rationale of the change, without delving into much detail.
Expand Down

0 comments on commit 89af877

Please sign in to comment.