Contributing

Casbin is an authorization library that implements access control models across multiple programming languages. Contributors with expertise in any supported language are welcome to participate in its development.

The project consists of two primary categories:

• Algorithm-focused projects - These involve implementing Casbin's core algorithms in various languages, including Go, Java, C++, Elixir, Dart, and Rust, along with their ecosystem integrations.

Casbin	jCasbin	node-Casbin	PHP-Casbin
Sẵn sàng cho sản xuất	Sẵn sàng cho sản xuất	Production-ready	Production-ready

PyCasbin	Casbin.NET	Casbin-CPP	Casbin-RS
Sẵn sàng cho sản xuất	Sản xuất sẵn sàng	Production-ready	Production-ready

• Application-based projects - These projects build applications on top of the Casbin library.

Dự án	Demo	Chi tiết	Tech Stack
Trình soạn thảo Casbin	Trình soạn thảo Casbin	A browser-based editor for creating and testing Casbin models and policies.	TypeScript + React

Ways to Contribute

There are multiple ways to help Casbin grow:

• Use Casbin and provide feedback - Your real-world experience helps us improve. Report bugs or suggest features on GitHub. Before opening an issue, consider discussing it first on Discord or GitHub Discussions.

  Note: Please describe issues in English.

• Improve documentation - Documentation improvements are an excellent starting point for new contributors.

• Resolve existing issues - Check our issue board for beginner-friendly tasks, labeled by difficulty level.

Submitting Pull Requests

Casbin develops on GitHub, making pull requests the standard contribution method.

Before submitting a pull request:

• Clearly explain the purpose and impact of your changes on the repository.

• Keep each pull request focused on a single change. Submit separate pull requests for unrelated modifications.

• When adding new files, include the Casbin license header at the top:

  // Copyright 2021 The casbin Authors. All Rights Reserved.
  //
  // Licensed under the Apache License, Version 2.0 (the "License");
  // you may not use this file except in compliance with the License.
  // You may obtain a copy of the License at
  //
  //      http://www.apache.org/licenses/LICENSE-2.0
  //
  // Unless required by applicable law or agreed to in writing, software
  // distributed under the License is distributed on an "AS IS" BASIS,
  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  // See the License for the specific language governing permissions and
  // limitations under the License.

• Use semantic commit messages following the format: <type>(<scope>): <subject>. <scope> là tùy chọn. For detailed guidelines, see Conventional Commits.

Licensing

All contributions to Casbin are licensed under the Apache License.