gotosocial/vendor/github.com/huandu/xstrings/CONTRIBUTING.md
Vyr Cossont fc3741365c
[bugfix] Fix Swagger spec and add test script (#2698)
* Add Swagger spec test script

* Fix Swagger spec errors not related to statuses with polls

* Add API tests that post a status with a poll

* Fix creating a status with a poll from form params

* Fix Swagger spec errors related to statuses with polls (this is the last error)

* Fix Swagger spec warnings not related to unused definitions

* Suppress a duplicate list update params definition that was somehow causing wrong param names

* Add Swagger test to CI

- updates Drone config
- vendorizes go-swagger
- fixes a file extension issue that caused the test script to generate JSON instead of YAML with the vendorized version

* Put `Sample: ` on its own line everywhere

* Remove unused id param from emojiCategoriesGet

* Add 5 more pairs of profile fields to account update API Swagger

* Remove Swagger prefix from dummy fields

It makes the generated code look weird

* Manually annotate params for statusCreate operation

* Fix all remaining Swagger spec warnings

- Change some models into operation parameters
- Ignore models that already correspond to manually documented operation parameters but can't be trivially changed (those with file fields)

* Documented that creating a status with scheduled_at isn't implemented yet

* sign drone.yml

* Fix filter API Swagger errors

* fixup! Fix filter API Swagger errors

---------

Co-authored-by: tobi <tobi.smethurst@protonmail.com>
2024-03-06 18:05:45 +01:00

1.4 KiB

Contributing

Thanks for your contribution in advance. No matter what you will contribute to this project, pull request or bug report or feature discussion, it's always highly appreciated.

New API or feature

I want to speak more about how to add new functions to this package.

Package xstring is a collection of useful string functions which should be implemented in Go. It's a bit subject to say which function should be included and which should not. I set up following rules in order to make it clear and as objective as possible.

  • Rule 1: Only string algorithm, which takes string as input, can be included.
  • Rule 2: If a function has been implemented in package string, it must not be included.
  • Rule 3: If a function is not language neutral, it must not be included.
  • Rule 4: If a function is a part of standard library in other languages, it can be included.
  • Rule 5: If a function is quite useful in some famous framework or library, it can be included.

New function must be discussed in project issues before submitting any code. If a pull request with new functions is sent without any ref issue, it will be rejected.

Pull request

Pull request is always welcome. Just make sure you have run go fmt and all test cases passed before submit.

If the pull request is to add a new API or feature, don't forget to update README.md and add new API in function list.