-
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
84879bb
commit 46b3767
Showing
1 changed file
with
42 additions
and
22 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 |
|---|---|---|
| @@ -1,42 +1,62 @@ | ||
| # Contributing to Simplify4U projects | ||
|
|
||
| Contributions are welcome! | ||
|
|
||
| We thank everybody for support us - one of the easiest way is giving a :star: | ||
| Contributions are welcome! | ||
|
|
||
| ## Bugs | ||
| We thank everybody for support us - one of the easiest way is giving a :star: | ||
|
|
||
| ## Joining to us :handshake: | ||
|
|
||
| As all projects - **Open Source** projects also need maintainers, so we invite you to join our organization. | ||
|
|
||
| If You're thinking about new project - we can give You ready infrastructure | ||
|
|
||
| - GitHub Actions | ||
| - Sonar integration | ||
| - deployment to Maven Central | ||
|
|
||
| So you can focus on features. | ||
|
|
||
| :handshake: **Together we can do more.** :handshake: | ||
|
|
||
| ## Bugs :bug: | ||
|
|
||
| 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 | ||
| - 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 :thinking: | ||
|
|
||
| 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. | ||
| 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 :writing_hand: | ||
|
|
||
| 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. | ||
| Before begin your work create issue with description what is your plan and that you start working on it. In order to | ||
| avoid no needed work. | ||
|
|
||
| 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 | ||
| ### New releases | ||
|
|
||
| After `PR` accept we will release new version in the month, in more case early. | ||
|
|
||
| ### 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 | ||
| ## Developer tools :hammer_and_wrench: | ||
|
|
||
| Most of the our projects use [sonarcloud](https://sonarcloud.io/organizations/simplify4u/) | ||
| to analyze code quality, please login on it using GitHub account. | ||
| Most of our projects use [sonarcloud](https://sonarcloud.io/organizations/simplify4u/) | ||
| to analyze code quality, please log in 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. | ||
| 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. | ||
| We use GitHub Action - so please look at result for automatic code building. |