Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ jobs:
- no-encryption-and-sqlite
- sqlite-cryptostore
- experimental-encrypted-state-events
- native-tls
- markdown
- socks
- sso-login
Expand Down
40 changes: 15 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ contributors' pull requests and pushes.

## Pull requests

Ideally, a PR should have a *proper title*, with *atomic logical commits*, and
each commit should have a *good commit message*.
Ideally, a PR should have a _proper title_, with _atomic logical commits_, and
each commit should have a _good commit message_.

A *proper PR title* would be a one-liner summary of the changes in the PR,
A _proper PR title_ would be a one-liner summary of the changes in the PR,
following the same guidelines of a good commit message, including the
area/feature prefix. Something like `FFI: Allow logs files to be pruned.` would
be a good PR title.
Expand Down Expand Up @@ -126,10 +126,10 @@ A good example of a changelog entry could look like the following:
For security-related changelog entries, please include the following additional
details alongside the pull request number:

* Impact: Clearly describe the issue's potential impact on users or systems.
* CVE Number: If available, include the CVE (Common Vulnerabilities and
- Impact: Clearly describe the issue's potential impact on users or systems.
- CVE Number: If available, include the CVE (Common Vulnerabilities and
Exposures) identifier.
* GitHub Advisory Link: Provide a link to the corresponding GitHub security
- GitHub Advisory Link: Provide a link to the corresponding GitHub security
advisory for further context.

```markdown
Expand All @@ -156,12 +156,12 @@ Conventional Commits are structured as follows:
The type of changes which will be included in changelogs is one of the
following:

* `feat`: A new feature
* `fix`: A bugfix
* `doc`: Documentation changes
* `refactor`: Code refactoring
* `perf`: Performance improvements
* `ci`: Changes to CI configuration files and scripts
- `feat`: A new feature
- `fix`: A bugfix
- `doc`: Documentation changes
- `refactor`: Code refactoring
- `perf`: Performance improvements
- `ci`: Changes to CI configuration files and scripts

The scope is optional and can specify the area of the codebase affected (e.g.,
olm, cipher).
Expand All @@ -174,10 +174,10 @@ changelog entry.

The metadata must be included in the following git-trailers:

* `Security-Impact`: The magnitude of harm that can be expected, i.e.
- `Security-Impact`: The magnitude of harm that can be expected, i.e.
low/moderate/high/critical.
* `CVE`: The CVE that was assigned to this issue.
* `GitHub-Advisory`: The GitHub advisory identifier.
- `CVE`: The CVE that was assigned to this issue.
- `GitHub-Advisory`: The GitHub advisory identifier.

Please include all the fields that are available.

Expand Down Expand Up @@ -334,16 +334,6 @@ on Git 2.17+ you can mass signoff using rebase:
git rebase --signoff origin/main
```

## Tips for working on the `matrix-rust-sdk` with specific IDEs

* [RustRover](https://www.jetbrains.com/rust/) will attempt to sync the project
with all features enabled, causing an error in `matrix-sdk` ("only one of the
features `native-tls` or `rustls-tls` can be enabled"). To work around this,
open `crates/matrix-sdk/Cargo.toml` in RustRover and uncheck one of the
`native-tls` or `rustls-tls` feature definitions:

![Screenshot of RustRover](.img/rustrover-disable-feature.png)

## AI policy

This policy is a copy of the [Forgejo's AI agreement][Forgejo].
Expand Down
Loading
Loading