diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..82e19f837 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,79 @@ +# Blackjax Code of Conduct + +## TL;dr: Be excellent to each other. + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting Blackjax Gardener +- Junpeng Lao [email](junpenglao@gmail.com) +- Alberto Cabezas Gonzalez [email](a.cabezasgonzalez@lancaster.ac.uk) + +All complaints will be reviewed and +investigated and will result in a response that is deemed necessary and +appropriate to the circumstances. The project team is obligated to maintain +confidentiality with regard to the reporter of an incident. Further details of +specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 000000000..ec9cf0b03 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,60 @@ +# Blackjax Governance Document + +## The Project +BlackJAX (or Blackjax, we use it interchangeably) is an open-source Bayesian inference library in the JAX scientific computation ecosystem. +Blackjax is designed to prioritize new Bayesian Inference algorithm development, with focus on modularity and ease of use to low level function, +while also being fast and compatible with multi hardwares thanks to JAX. + +The Blackjax project was created by [Rémi Louf](https://github.com/rlouf) as a +[Single-Maintainer Houseplant project](https://github.com/OpenTechStrategies/open-source-archetypes/blob/main/arch-houseplant.ltx) +following the BDFL model of governance. We have since moved to the governance model of +[Specialty Library](https://github.com/OpenTechStrategies/open-source-archetypes/blob/main/arch-specialty-library.ltx) and benefited from a community +of contributors. This document outlines the governance structure for the current status. + +## Roles +* Contributors: Anyone who contributes to the BlackJAX project is considered a contributor. This includes submitting code, filing issues, reviewing pull requests, and participating in discussions. They are listed under: + * https://github.com/blackjax-devs/blackjax/graphs/contributors + * https://github.com/blackjax-devs/sampling-book/graphs/contributors +* Core contributors: Core contributors are contributors who have made significant contributions to the BlackJAX project, for example large modules or functionality. +* Blackjax gardeners: Gardeners are core contributors who are responsible for maintaining the project and making decisions about its future direction. Blackjax gardeners have the ability to merge pull requests into the BlackJAX repository. + * Currently [junpenglao@](https://github.com/junpenglao) and [albcab@](https://github.com/albcab) are gardeners of Blackjax. + + +## Responsibility +We cannot hold anyone responsible really since we are all doing free work here, but some general expectations are: +* Contributors are responsible for following the project's code of conduct and contributing to the project in a positive and constructive manner. Contributors are also responsible for testing their code and ensuring that it meets the project's standards. +* Core contributors are expected to review pull requests and provide feedback to contributors. They also make decisions about the architecture and implementation of the module/functionality they contributed to. Also the “if you broke something please fix it” applies. +* Maintainers are responsible for monitoring the benchmark, the documentation and the website are up to date and built passed, update dependency and apply best practice + + +In addition to these specific responsibilities, all contributors are encouraged to participate in discussions about the project and to help out in any way they can. + + +## Decision-making +Decisions about the BlackJAX project are made by consensus among the Blackjax gardeners. This means that all Blackjax gardeners must agree on a decision before it can be implemented. If a consensus cannot be reached, we will flip a (virtual) coin. + + +## Communication +Communication about the BlackJAX project takes place in the following channels: + + +GitHub issues: Issues are used to track bugs, feature requests, and other tasks. +GitHub discussion: Discussions are used to answer user questions, scope for features, and discuss solutions to bugs. +GitHub pull requests: Pull requests propose changes to the BlackJAX codebase. +Discord: The BlackJAX Discord workspace is used for internal communication about the project for core contributors. + + +## Contributing +Anyone is welcome to contribute to the BlackJAX project. Contributions can be made in the form of code, documentation, or other forms of support. To learn more about how to contribute, please see the contributing guide. + + +## Code of conduct +All contributors to the BlackJAX project are expected to follow the project's code of conduct. The code of conduct outlines the expected behavior of contributors and helps to ensure a welcoming and productive environment for all. + + +## Governance changes +This governance document is subject to change. Changes to the governance document must be approved by consensus among the core contributors. + + +## Contact +If you have any questions about the BlackJAX project, please feel free to contact the maintainers.