Skip to content

Commit 45d3596

Browse files
committed
docs: add Contributing md
1 parent 117aac5 commit 45d3596

File tree

3 files changed

+24
-6
lines changed

3 files changed

+24
-6
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to Mosaic, wether its a new component / tool or an update to existing ones! There are
4+
just a few small guidelines you need to follow :)
5+
6+
## New Features/Libraries
7+
8+
Before contributing large new features and/or library please reach out with discussion first.
9+
## Code Reviews
10+
11+
All submissions, including submissions by project members, require review. We
12+
use GitHub pull requests for this purpose. Consult
13+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
14+
information on using pull requests.
15+
16+
### CI/CD Checks
17+
We have a GitHub Actions workflow that is being activated as part of any raised Pull Request, it will run the tests, spotless and detekt checks.
18+
19+
You can also run this locally to make sure the PR will pass these checks:
20+
21+
- Spotless: Run `./gradlew spotlessApply` to apply formatting to the code according to the spec.
22+
23+
- Detekt: Run `./gradlew detekt` to run static code analysis using Detekt.

generate_docs.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
cp README.md docs/index.md
44
cp CHANGELOG.md docs/changelog.md
55
cp LICENSE docs/license.md
6+
cp CONTRIBUTING.md docs/contributing.md
67

78
# README is located on the root of the project, and index is inside of docs
89
# so wee need to replace ./docs/assets references with ./assets

mkdocs.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,6 @@ theme:
1111
text: 'Arimo'
1212
features:
1313
- content.code.copy
14-
- navigation.instant
15-
- navigation.instant.prefetch
16-
- navigation.path
17-
- navigation.sections
18-
- navigation.sections.expand
19-
- navigation.expand
2014

2115
palette:
2216
primary: custom

0 commit comments

Comments
 (0)