-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c6cffe6
commit fca389a
Showing
3 changed files
with
49 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.idea | ||
.DS_STORE | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Contributing to Simplify4U projects | ||
|
||
Contributions are welcome! | ||
|
||
We thanks everybody for support us - one of the easiest way is giving a :star: | ||
|
||
## Bugs | ||
|
||
If you found bug or think that something not working as required | ||
- check if somebody didn't create issue with similar case | ||
- if not found issue don't hesitate create new one with many information as possible how to reproduce it | ||
|
||
## New feature | ||
|
||
You think that something useful should be add to our projects - create issue with description of your case | ||
and context how or where new feature can be used. | ||
|
||
## Pull requests | ||
|
||
Pull requests are welcome with big thanks. | ||
|
||
Even small change can help us to deliver better software - so be brave. | ||
|
||
Before begin your work create issue with description what is your plan and that you start working on it. | ||
|
||
If you want to start working on existing issue please let us know by comment. | ||
|
||
## Good practices for PR | ||
|
||
- one PR - one commit - so please squash all if required | ||
- one PR - one feature - so if changes are independent please create many PR | ||
- after review with change request please answer in 14 days | ||
|
||
## Developer tools | ||
|
||
Most of the our projects use [sonarcloud](https://sonarcloud.io/organizations/simplify4u/) | ||
to analyze code quality, please login on it using GitHub account. | ||
|
||
You can install and configure [sonarlint](https://www.sonarlint.org/) in your IDE | ||
to detect some code quality issue early. | ||
|
||
We use Travis or/and GitHub Action CI - so please look at result for automatic code building. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
<!-- before merge PR please squash your commits to one --> | ||
<!-- if you have done task which can be merged independently - please create separate PR --> | ||
<!-- Good practices for PR --> | ||
<!-- one PR - one commit - so please squash all if required --> | ||
<!-- one PR - one feature - so if changes are independent please create many PR --> | ||
<!-- after review with change request please answer in 14 days --> |