Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme contributing and faq #2885

Merged
merged 10 commits into from
Jun 15, 2023
Merged

Update readme contributing and faq #2885

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dbb037e
update FAQ, README and Contribution Guidelines
aurindam Jun 14, 2023
ee29824
Update CONTRIBUTING.md
aurindam Jun 15, 2023
dff1563
Update README
aurindam Jun 15, 2023
1cf77c8
Update README.md
aurindam Jun 15, 2023
1b136df
Update README.md
aurindam Jun 15, 2023
bf7d57f
Apply suggestions from code review
aurindam Jun 15, 2023
43db4a4
Apply suggestions from code review
aurindam Jun 15, 2023
00ab65d
Update FAQ.md
aurindam Jun 15, 2023
15eb9d2
Update styling
aurindam Jun 15, 2023
8a1446c
Update statement on commitment
aurindam Jun 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 21 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
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.