-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
222 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| # Code of Conduct | ||
|
|
||
| The signac team is committed to fostering a diverse and welcoming community. | ||
| The signac project has therefore adopted the [Contributor Covenant Code of Conduct](https://signac.io/conduct/). | ||
| The signac project has therefore adopted the [Contributor Covenant Code of Conduct](conduct.md). | ||
| Please email [[email protected]](mailto:[email protected]) if you have any questions or concerns. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making 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 both within project spaces and in public spaces | ||
| when an individual is representing the project or its community. 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 the project team at [[email protected]](mailto:[email protected]). 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 | ||
|
|
||
| For answers to common questions about this code of conduct, see | ||
| https://www.contributor-covenant.org/faq | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| ## About | ||
|
|
||
| The signac project is a consensus-based, open source community project with the goal to develop software aiding in the management of data and the implementation and execution of workflows that operate on said data. | ||
| Anyone with an interest in the project can join the community, contribute to the project design and participate in the decision making process. | ||
| This document describes how that participation takes place and what roles community members may be able to fill and the responsibilities and privileges these roles imply. | ||
| The project is defined by the collective of all contributors and the intellectual property created by that collective (typically managed in git repositories), but does not represent a legal entity in any other way. | ||
| The project is affiliated with the 501(c)3 [NumFOCUS Foundation](https://numfocus.org), but does not have any special responsibilities as a result of that affiliation. | ||
|
|
||
| ## Roles and Responsibilities | ||
|
|
||
| ### Users | ||
|
|
||
| Users are community members who make use of the project. | ||
| They are the most important members of the community since without them the project would have no purpose. | ||
| Anyone can be a user; there are no special requirements. | ||
| The project encourages users to participate in the project and community as much as possible. | ||
| User contributions enable the project team to ensure that they are satisfying the needs of those users. | ||
| Common user activities include, but are not limited to: | ||
|
|
||
| * sharing the project with others (e.g. a link on a website and word-of-mouth awareness raising) | ||
| * informing developers of strengths and weaknesses from a (new) user perspective | ||
| * citing the project software when used in academic works | ||
| * providing moral support (a "thank you" goes a long way) | ||
|
|
||
| There are many ways that users can contribute to the project, described below. | ||
|
|
||
| ### Contributors | ||
|
|
||
| Any community member can become a contributor, and contributions can take many forms. | ||
| There is no expectation of long-term commitment to the project, no specific skill requirements, and no selection process, however all contributors must abide by the project's [Code of Conduct]({{ '/conduct/' | absolute_url }}) and each repository's respective contributing guidelines. | ||
| Ways to contribute include, but are not limited to: | ||
|
|
||
| * supporting new users (existing users are often the best people to support new users) | ||
| * reporting issues | ||
| * identifying requirements | ||
| * writing documentation | ||
| * providing graphics and web design | ||
| * providing code contributions | ||
| * assisting with project infrastructure | ||
| * attending development meetings | ||
|
|
||
| Contributors are asked to submit code changes via pull requests. | ||
| Committers will review these contributions and help to prepare them for inclusion in a future release of the software. | ||
| Contributors may be asked to serve as additional reviewers on other pull requests and may become a committer if desired (see below). | ||
|
|
||
| ### Committers | ||
|
|
||
| Committers are contributors who have shown that they are committed to the continued development of the project through ongoing engagement with the community. | ||
| Committer roles are project-wide, i.e., for all repositories. | ||
|
|
||
| Committers: | ||
|
|
||
| * may be assigned as the primary reviewer for a pull request and are permitted to merge it | ||
| * may triage and close issues | ||
| * are expected to be aware of the general strategic development of the project, e.g., by being active on the Slack or [Gitter channels](https://gitter.im/signac/Lobby) and/or by attending development meetings on a semi-regular basis | ||
|
|
||
| Potential committers must also possess the necessary technical expertise to evaluate code contributions, as well as a high level understanding of and alignment with the project's objectives and strategy. | ||
| New committers are identified by (self) nomination. | ||
| The project maintainers will make a decision on whether to accept or reject the nomination by majority vote. | ||
| The committer role may be revoked by the project maintainers by majority vote if warranted, for example due to prolonged inactivity. | ||
|
|
||
| ### Project maintainers | ||
|
|
||
| The project maintainers manage the project. | ||
| Their responsibilities include: | ||
|
|
||
| * administering the GitHub repositories | ||
| * triaging issues and pull requests | ||
| * scheduling and creating releases | ||
| * maintaining a project roadmap | ||
| * representing the project to the community | ||
|
|
||
| In addition, all project maintainers are expected to be available for discussions and decision-making processes on: | ||
|
|
||
| * the acceptance or rejection of nominations for committers and project maintainers | ||
| * the project's strategic direction | ||
|
|
||
| Maintainers who are also committers may commit small changes (documentation updates, code comments, CI configuration changes) without a pull request. | ||
|
|
||
| Any community member who has shown exceptional commitment to the signac project and strong understanding of its overall strategy may be invited to become a project maintainer. | ||
| New project maintainers are approved by the existing project maintainers by two-thirds vote. | ||
| Any project maintainer may resign from this role at any point; a project maintainer may also be removed from their role by other project leads by two-thirds vote if circumstances require such a drastic step. | ||
|
|
||
| ### Administrators | ||
|
|
||
| Administrators manage the infrastructure required for the continuity of the signac project. | ||
| This includes, but is not limited to: the GitHub organization, the domain name, the Slack channel, social media accounts, and the website. | ||
|
|
||
| ## Project Managers | ||
|
|
||
| The signac project employs a rotating managers approach (inspired by [numba](https://github.com/numba/numba/wiki/Numba-Czar-Cheatsheet)) to keep everything running smoothly. | ||
| At any given time, certain members of the project team are assigned to various roles required to sustain the forward progress of the project. | ||
| In general, managers are selected from a pool consisting of all project maintainers and volunteer project committers (with one exception, see below). | ||
| Manager roles rotate periodically in alphabetical order by last name, and each current manager is responsible for contacting the next person to occupy that position. | ||
|
|
||
| ### Community Manager | ||
|
|
||
| This role rotates on a monthly basis, starting on the first of every month. | ||
| It encompasses the following tasks: | ||
|
|
||
| * Scheduling and setting the agenda for the biweekly signac meetings (and canceling if necessary). | ||
| * Maintaining the signac social media accounts. | ||
| * Preparing any project updates for the NumFOCUS newsletter. | ||
|
|
||
| <small> | ||
| **Directory of roles** The project maintainers, committers, and administrators are listed [here]({{ site.baseurl }}/about/). | ||
| The committers and contributors to the project are listed individually for each repository in the respective `contributors.yaml` file. | ||
| </small> | ||
|
|
||
| ----- | ||
| <small> | ||
| This work is a derivative of the Meritocratic Governance Model. | ||
| This work is licensed under Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) License. | ||
| </small> |
Oops, something went wrong.