Skip to content

Commit

Permalink
update FAQ, README and Contribution Guidelines
Browse files Browse the repository at this point in the history
Update Contribution Guidelines

Update FAQ

Update README.md

Rearrange README

Fix typos
  • Loading branch information
aurindam committed Jun 15, 2023
1 parent 73a7716 commit 105d0be
Show file tree
Hide file tree
Showing 3 changed files with 206 additions and 208 deletions.
32 changes: 21 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
# Contributing

We warmly welcome contributions to the project. Let's discuss ideas or questions in [Github discussions](https://github.com/slint-ui/slint/discussions).
Please feel welcome to open github issues, pull requests or comment for example on [RFC tagged](https://github.com/slint-ui/slint/labels/rfc) issues.
We warmly welcome contributions to the project. Let's discuss ideas or questions
in [Github discussions](https://github.com/slint-ui/slint/discussions).
Please feel welcome to open github issues, pull requests or comment for example
on [RFC tagged](https://github.com/slint-ui/slint/labels/rfc) issues.

## Contributor License Agreement

All contributions are accepted under the terms of the MIT No Attribution License.
Please note that you must have written the contribution 100% yourself and that
no rights have been transferred to third parties (e.g. your employer).
In any other case, please let us know.

When opening a pull request, you will be asked to sign a
[Contributor License Agreement (CLA)](https://cla-assistant.io/slint-ui/slint).

## Coding Style

For the Rust portion of the code base, we enforce the coding style via rustfmt. The [`rustfmt.toml`](/rustfmt.toml) in the root direction is used to configure the style.
For the Rust portion of the code base, we enforce the coding style via rustfmt.
The [`rustfmt.toml`](/rustfmt.toml) in the root direction is used to configure
the style.

For the C++ portion of the code base, we enforce the coding style via `clang-format`, via the [`.clang-format`](/.clang-format) file in the root directory.
For the C++ portion of the code base, we enforce the coding style via `clang-format`,
via the [`.clang-format`](/.clang-format) file in the root directory.

## Tooling

Expand Down Expand Up @@ -36,10 +51,5 @@ Typical modules to skip include: `cspell`, `check-json` and `prettier`.

## Testing

All changes submitted to the repository are automatically built and tested via Github Actions and the corresponding workflow defined in the [`rust.yaml`](/.github/workflows/rust.yaml) file.

## Contributor License Agreement

When opening a pull request, you will be asked to sign a [Contributor License Agreement (CLA)](https://cla-assistant.io/slint-ui/slint) which
will allow us to relicense your contribution.
Please contact us for any concerns.
All changes submitted to the repository are automatically built and tested via
Github Actions and the corresponding workflow defined in the [`rust.yaml`](/.github/workflows/rust.yaml) file.
Loading

0 comments on commit 105d0be

Please sign in to comment.