The following is a set of guidelines for contributing to casbin and its libraries, which are hosted at casbin organization at Github.
This project adheres to the Contributor Covenant 1.2. By participating, you are expected to uphold this code. Please report unacceptable behavior to info@casbin.com.
- We do our best to have un up to date documentation
- Stack Overflow is the best place to start if you have a question. Please use the casbin tag we are actively monitoring. We encourage you to use Stack Overflow specially for Modeling Access Control Problems, in order to build a shared knowledge base.
- You can also join our Discord.
Reporting issues are a great way to contribute to the project. We are perpetually grateful about a well-written, thorough bug report.
Before raising a new issue, check our issue list to determine if it already contains the problem that you are facing.
A good bug report shouldn't leave others needing to chase you for more information. Please be as detailed as possible. The following questions might serve as a template for writing a detailed report:
What were you trying to achieve? What are the expected results? What are the received results? What are the steps to reproduce the issue? In what environment did you encounter the issue?
Feature requests can also be submitted as issues.
Good pull requests (e.g. patches, improvements, new features) are a fantastic help. They should remain focused in scope and avoid unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing new features, refactoring code etc.), otherwise you risk spending a lot of time working on something that the maintainers might not want to merge into the project.
First add an issue to the project to discuss the improvement. Please adhere to the coding conventions used throughout the project. If in doubt, consult the LuaRocks Lua Style Guide.