Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 2.33 KB

File metadata and controls

37 lines (22 loc) · 2.33 KB

Contributing

This repository is part of the eclipse-biscuit project. It is licensed under BSD-3-Clause and requires contributors to sign the Eclipse Contributor Agreement (see #eclipse-contributor-agreement below).

Before contributing

This is an implementation of the biscuit specification. All changes pertaining to the specification must be discussed in the specification repo first.

Unless you’re fixing a trivial issue, it is a good idea to start by opening an issue, in order to gather feedback about the changes you have in mind.

You can also ask questions on the implementers matrix chat.

Code organization

  • biscuit provides core support for biscuit-auth
  • biscuit-servant provides support for protecting servant applications
  • biscuit-wai provides WAI middlewares for protecting WAI applications

Project communication

The discussion space is a matrix chat. Updates are also posted on bluesky and mastodon.

Security issues can be reported via github.

Eclipse Contributor Agreement

From the ECA FAQ:

The purpose of the ECA is to provide a written record that you have agreed to provide your contributions of code and documentation under the licenses used by the Eclipse project(s) you're contributing to. It also makes it clear that you are promising that what you are contributing to Eclipse is code that you wrote, and you have the necessary rights to contribute it to our projects. And finally, it documents a commitment from you that your open source contributions will be permanently on the public record.

In order to sign the ECA, you can follow these steps:

  • Create an account on dev.eclipse.org
  • Go to Edit Profile, then Link GitHub Account, then enter your GitHub ID and click Update Account
  • Read and sign the ECA
  • Use the exact same email address for your Eclipse account and your commit author.