stb/.github/CONTRIBUTING.md

33 lines
1.4 KiB
Markdown
Raw Normal View History

2017-01-16 08:41:31 +03:00
Pull Requests and Issues are both welcome.
2017-01-16 08:44:34 +03:00
# Responsiveness
2017-01-16 08:41:31 +03:00
General priority order is:
* Crashes
2020-02-01 17:19:59 +03:00
* Security issues in stb_image
2017-01-16 08:41:31 +03:00
* Bugs
2020-02-01 17:19:59 +03:00
* Security concerns in other libs
2017-01-16 08:41:31 +03:00
* Warnings
* Enhancements (new features, performance improvement, etc)
Pull requests get priority over Issues. Some pull requests I take
as written; some I modify myself; some I will request changes before
accepting them. Because I've ended up supporting a lot of libraries
(20 as I write this, with more on the way), I am somewhat slow to
address things. Many issues have been around for a long time.
2017-01-16 08:44:34 +03:00
# Pull requests
2017-01-16 08:41:31 +03:00
2020-02-01 17:17:14 +03:00
* Make sure you're using a special branch just for this pull request. (Sometimes people unknowingly use a default branch, then later update that branch, which updates the pull request with the other changes if it hasn't been merged yet.)
2017-01-16 08:41:31 +03:00
* Do NOT update the version number in the file. (This just causes conflicts.)
* Do add your name to the list of contributors. (Don't worry about the formatting.) I'll try to remember to add it if you don't, but I sometimes forget as it's an extra step.
2020-02-02 19:15:40 +03:00
* Your change needs to compile as both C and C++. Pre-C99 compilers should be supported (e.g. declare at start of block)
2017-01-16 08:41:31 +03:00
2017-01-16 08:44:34 +03:00
# Specific libraries
2017-01-16 08:41:31 +03:00
I generally do not want new file formats for stb_image because
we are trying to improve its security, so increasing its attack
surface is counter-productive.