git.sr.ht/~pingoo/stdx@v0.0.0-20240218134121-094174641f6e/validate/CONTRIBUTING.md (about)

     1  #### Support
     2  If you do have a contribution to the package, feel free to create a Pull Request or an Issue.
     3  
     4  #### What to contribute
     5  If you don't know what to do, there are some features and functions that need to be done
     6  
     7  - [ ] Refactor code
     8  - [ ] Edit docs and [README](https://github.com/asaskevich/govalidator/README.md): spellcheck, grammar and typo check
     9  - [ ] Create actual list of contributors and projects that currently using this package
    10  - [ ] Resolve [issues and bugs](https://github.com/asaskevich/govalidator/issues)
    11  - [ ] Update actual [list of functions](https://github.com/asaskevich/govalidator#list-of-functions)
    12  - [ ] Update [list of validators](https://github.com/asaskevich/govalidator#validatestruct-2) that available for `ValidateStruct` and add new
    13  - [ ] Implement new validators: `IsFQDN`, `IsIMEI`, `IsPostalCode`, `IsISIN`, `IsISRC` etc
    14  - [x] Implement [validation by maps](https://github.com/asaskevich/govalidator/issues/224)
    15  - [ ] Implement fuzzing testing
    16  - [ ] Implement some struct/map/array utilities
    17  - [ ] Implement map/array validation
    18  - [ ] Implement benchmarking
    19  - [ ] Implement batch of examples
    20  - [ ] Look at forks for new features and fixes
    21  
    22  #### Advice
    23  Feel free to create what you want, but keep in mind when you implement new features:
    24  - Code must be clear and readable, names of variables/constants clearly describes what they are doing
    25  - Public functions must be documented and described in source file and added to README.md to the list of available functions
    26  - There are must be unit-tests for any new functions and improvements
    27  
    28  ## Financial contributions
    29  
    30  We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/govalidator).
    31  Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
    32  
    33  
    34  ## Credits
    35  
    36  
    37  ### Contributors
    38  
    39  Thank you to all the people who have already contributed to govalidator!
    40  <a href="https://github.com/asaskevich/govalidator/graphs/contributors"><img src="https://opencollective.com/govalidator/contributors.svg?width=890" /></a>
    41  
    42  
    43  ### Backers
    44  
    45  Thank you to all our backers! [[Become a backer](https://opencollective.com/govalidator#backer)]
    46  
    47  <a href="https://opencollective.com/govalidator#backers" target="_blank"><img src="https://opencollective.com/govalidator/backers.svg?width=890"></a>
    48  
    49  
    50  ### Sponsors
    51  
    52  Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/govalidator#sponsor))
    53  
    54  <a href="https://opencollective.com/govalidator/sponsor/0/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/0/avatar.svg"></a>
    55  <a href="https://opencollective.com/govalidator/sponsor/1/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/1/avatar.svg"></a>
    56  <a href="https://opencollective.com/govalidator/sponsor/2/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/2/avatar.svg"></a>
    57  <a href="https://opencollective.com/govalidator/sponsor/3/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/3/avatar.svg"></a>
    58  <a href="https://opencollective.com/govalidator/sponsor/4/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/4/avatar.svg"></a>
    59  <a href="https://opencollective.com/govalidator/sponsor/5/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/5/avatar.svg"></a>
    60  <a href="https://opencollective.com/govalidator/sponsor/6/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/6/avatar.svg"></a>
    61  <a href="https://opencollective.com/govalidator/sponsor/7/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/7/avatar.svg"></a>
    62  <a href="https://opencollective.com/govalidator/sponsor/8/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/8/avatar.svg"></a>
    63  <a href="https://opencollective.com/govalidator/sponsor/9/website" target="_blank"><img src="https://opencollective.com/govalidator/sponsor/9/avatar.svg"></a>