Thank you for considering contributing! I write libraries in my free time and contributions from others help me make great tools.
Following these guidelines helps to communicate that you respect my time, as the developer managing and developing this open source project. In return, I should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
Questions and pull requests are more than welcome. I follow Elixir's tenet of bad documentation being a bug, so if anything is unclear, please file an issue! Ideally, my answer to your question will be in an update to the docs.
Please note that this project is released with a Contributor [Code of Conduct]. By participating in this project you agree to abide by its terms.
mix formaton your files before committing them. I like clean diffs.
mix credoand resolve anything of yours that comes up.
use Liberator.Resourcein an empty module in an empty Phoenix project, and make a request that returns
200 OK, you're doing great.
If you're on GitHub, it's really easy to submit a pull request. Just:
I don't require a CLA or anything like that.
You can also email a patch to the mailing list if you like things old-school.
If you find a security vulnerability, do NOT open an issue. Contact Rosa on keybase.io instead!
In order to determine whether you are dealing with a security issue, ask yourself these two questions:
If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, message me directly. For more information on security, see SECURITY.md.
Otherwise, please open an issue.
The philosopy of this project is to create a small, sharp tool that takes the burden of the HTTP spec off of the shoulders of developers. Feature requests and enhancements should stick to this philosophy. Help me implement the HTTP spec more closely, or help me do anything that lets developers do more with their valuable time.
Feature requests give meaning to my work. Open an issue that decribes the feature you'd like to see, why you need it, and how you'd like it to work.
As the primary developer, I will be the one reviewing all pull requests. I'm online far too much, so you should be able to hear back from me quickly. However, I only do this in my free time, so please allow me flexibility.
[help wanted]: https://todo.sr.ht/~cosmicrose/liberator?search=label%3A"help wanted" [good first issue]: https://todo.sr.ht/~cosmicrose/liberator?search=label%3A"help wanted" [Code of Conduct]: code_of_conduct.md