Skip to content

Latest commit

 

History

History
76 lines (65 loc) · 7.12 KB

CONTRIBUTING.md

File metadata and controls

76 lines (65 loc) · 7.12 KB

Code Style

While we appreciate all the help we can get, here are some more details on the coding convention. Please, follow these guidelines and set up your IDE to use the respective code style configuration file.

Code of Conduct

If would like to contribute to our project and contribute to our work, please follow our Code of Conduct.

Pull Requests

Please, follow these basic rules when creating pull requests. Pull requests:

  • Should:
    • Be tidy
    • Easy to read
    • Have optimized imports
    • Contain a sufficient amount of comments, if this is a new feature
    • Where applicable, contain a reasonable, (even, if it's just a minimalistic), set of test cases, that cover the bases
  • Should not:
    • Change the existing formatting of code, unless this is really required, especially of files that have no other changes, or are not related to the pull request at all. (Please, don't enable pre-commit features in IDE-s such as "Reformat code", "Re-arrange code" and so on, as this may add extra noise to the pull and make the diff harder to read. When adding, or changing code, apply the re-formatting, only to the respective changed code blocks).
    • Have unresolved merge conflicts with the base branch
    • Have failing tests
    • Contain unaddressed critical issues reported by Sonar
    • Have commented out dead code. (Commented out code is fine, just not blocks and blocks of it).
    • Contain public static void(String[] args]) methods (as those would clearly have been used for the sake of quick testing without an actual test case)

Once you've created a new pull request, kindly first review the diff thoroughly yourselves, before requesting it to be reviewed by others and merged.

Legal

To accept, please:

  • Fill in all the mandatory fields
    • Full name (mandatory)
    • Company (optional -- please, only fill this, if you're contributing work on behalf of a company)
    • E-mail (mandatory)
    • Mailing address (mandatory)
    • Country (mandatory)
    • Telephone (optional)
  • Print, sign and scan the Individual Contributor's License Agreement (ICLA), or, alternatively, fill in the ICLA PDF file and mail it back to carlspring@gmail.com.
  • Add your name and basic details below and open a pull request.

Notes: Please, note that none of this information is shared with third-parties and is only required due to the legal agreement which you will be entering when contributing your code to the project. We require this minimal amount of information in order to be able to identify you, as we're not keeping record, or more sensitive information, such as passport/ID details. We will not send you any spam, or share your details with third parties.

Name Company Location Date
Martin Todorov Carlspring Consulting & Development Ltd. London, United Kingdom 2013-08-02
Steve Todorov Carlspring Consulting & Development Ltd. Sofia, Bulgaria 2014-01-12
Dmytro Chyzhykov Frankfurt am Main, Germany 2014-06-07
Nicolay Karakulov Kharkhiv, Ukraine 2014-10-05
Denis Ivaykin Moscow, Russia 2014-04-19
Juan Ignacio Bais Buenos Aires, Argentina 2016-02-24
Ivan Ursul Lviv, Ukraine 2016-05-02
Alex Oreshkevich redsoft.pro Minsk, Republic of Belarus 2016-05-12
Faisal Hameed DevFactory Lahore, Islamic Republic of Pakistan 2016-06-10
Orest Kyrylchuk Lviv, Ukraine 2016-05-28
Bohdan Hliva Lviv, Ukraine 2016-08-09
Yougeshwar Khatri Karachi, Pakistan 2016-04-01
Kate Novik redsoft.pro Minsk, Republic of Belarus 2016-11-16
Sergey Bespalov Novosibirsk, Russia 2016-11-02
Sergey Panov Kiev, Ukraine 2016-11-02
Nenko Tabakov Sofia, Bulgaria 2016-11-07
Przemyslaw Fusik Maszewo, Poland 2017-04-09
Dinesh Arora Charlotte, USA 2017-12-07
Sanket Sawant Mumbai, India 2017-12-09
Pablo Tirado Madrid, Spain 2018-01-05
Gokhan Kuyucak Izmir, Turkey 2018-01-14
Guido Grazioli London, United Kingdom 2018-01-15
Maxim Antonov Moscow, Russian Federation 2018-01-14
Aditya Srinivasan Washington DC, USA 2018-02-02
Sevastyan Pigarev Barnaul, Russian Federation 2018-03-27
Michael Altenburger Vienna, Austria 2018-09-29
Benjamin March Munich, Germany 2018-10-28
Konstantina Papadopoulou Thessaloniki, Greece 2018-12-28
Jitesh Golatkar Charlotte, USA 2019-01-25
Forrest Whiting Forbes Media Jersey City, New Jersey, USA 2019-02-04
Dawid Antecki Bielsko-Biala, Poland 2019-02-18