Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

62 lines (36 loc) · 1.99 KB

Contributing to Simplify4U projects

Contributions are welcome!

We thank everybody for support us - one of the easiest way is giving a ⭐

Joining to us 🤝

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.

🤝 Together we can do more. 🤝

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. In order to avoid no needed work.

If you want to start working on existing issue please let us know by comment.

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 🛠️

Most of our projects use sonarcloud to analyze code quality, please log in on it using GitHub account.

You can install and configure sonarlint in your IDE to detect some code quality issue early.

We use GitHub Action - so please look at result for automatic code building.