Перейти к основному содержимому

Contributing

Casbin — это библиотека авторизации с открытым исходным кодом, реализованная на многих языках. Мы приветствуем контрибьюторов на любом из поддерживаемых языков.

Проект делится на две основные области:

  • Ядро и порты на языки — Реализация ядра Casbin и экосистемы на Go, Java, Node.js, PHP, Python, .NET, C++, Rust и других языках.
golangjavanodejsphp
CasbinjCasbinnode-CasbinPHP-Casbin
Готово к использованию в продакшенеГотово к использованию в продакшенеГотово к использованию в продакшенеГотово к использованию в продакшене
pythondotnetc++rust
PyCasbinCasbin.NETCasbin-CPPCasbin-RS
Готово к использованию в продакшенеГотово к использованию в продакшенеГотово к использованию в продакшенеГотово к использованию в продакшене
  • Приложения и инструменты — Проекты, созданные на базе Casbin (например, редакторы, панели управления).
ПроектДемоДеталиСтек технологий
Casbin EditorCasbin EditorБраузерный редактор для создания и тестирования моделей и политик Casbin.TypeScript + React

Способы внести вклад​

  • Используйте Casbin и оставляйте обратную связь — Сообщайте об ошибках или предлагайте новые функции на GitHub. Для обсуждения крупных идей сначала используйте Discord или GitHub Discussions. Пожалуйста, используйте английский язык для задач и обсуждений.

  • Улучшайте документацию — Документация — отличный способ начать; исправления и уточнения всегда приветствуются.

  • Работайте над задачами — Просмотрите доску проекта, чтобы увидеть открытые задачи; многие из них помечены по уровню сложности.

Отправка pull request​

Мы используем GitHub и стандартный рабочий процесс с pull request.

Перед отправкой:

  • Четко опишите цель и влияние ваших изменений.

  • Держите каждый PR сфокусированным (одна функция или исправление). Разделяйте несвязанные изменения на отдельные PR.

  • При добавлении новых файлов включайте заголовок лицензии Casbin в начало файла:

    // 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>. The <scope> is optional. For detailed guidelines, see Conventional Commits.

Лицензирование​

Все вклады в Casbin лицензируются под Apache License.

Comments are powered by giscus and GitHub Discussions. They load from giscus.app and GitHub only after you click the button below.