36 lines
2.3 KiB
Markdown
36 lines
2.3 KiB
Markdown
# How to contribute
|
|
|
|
The following is a set of guidelines for contributing to Apache Casbin and its libraries, which are hosted at [Apache Casbin organization at Github](https://github.com/apache).
|
|
|
|
This project adheres to the [Contributor Covenant 1.2.](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct.html) By participating, you are expected to uphold this code. Please report unacceptable behavior to info@casbin.com.
|
|
|
|
## Questions
|
|
|
|
- We do our best to have an [up-to-date documentation](https://casbin.apache.org/docs/overview)
|
|
- [Stack Overflow](https://stackoverflow.com) is the best place to start if you have a question. Please use the [casbin tag](https://stackoverflow.com/tags/casbin/info) 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](https://discord.gg/S5UjpzGZjN).
|
|
|
|
## Reporting issues
|
|
|
|
Reporting issues are a great way to contribute to the project. We are perpetually grateful about a well-written, through bug report.
|
|
|
|
Before raising a new issue, check our [issue list](https://github.com/apache/casbin/issues) 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.
|
|
|
|
## Pull requests
|
|
|
|
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 [Effective Go style guide](https://golang.org/doc/effective_go.html).
|