Skip to content

Commit

Permalink
Added governance and contribution policies
Browse files Browse the repository at this point in the history
  • Loading branch information
JoanGi committed Oct 24, 2022
1 parent 86e8163 commit a49cbcf
Show file tree
Hide file tree
Showing 6 changed files with 191 additions and 0 deletions.
109 changes: 109 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Code of Conduct


## Short Version
We as members, contributors, and leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Need Help?
If ANY behavior makes you uncomfortable, or you believe it breaches the intent of this code of conduct, please contact a project maintainer:

* [Joan Giner](https://github.com/JoanGi/) (he/him)
* [Abel Gómez](https://github.com/abelgomez/) (he/him)
* [Jordi Cabot](https://github.com/jcabot/) (he/him)

---

## Long Version

As contributors and maintainers in this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in 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:

* Demonstrating empathy and kindness toward other people
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Giving and gracefully accepting constructive feedback
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* Violent threats or language directed against another person.
* Sexist, racist, or otherwise discriminatory jokes and language.
* 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

## Enforcement 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, including contributors, maintainers, administrators, and any kind of participant in the project.

Project maintainers will enforce this code at all times. We expect cooperation from all participants to ensure a safe environment for everyone.

The Code of Conduct, and the project leaders, can only address behavior in the present, not past behavior or fears of what someone might do based on past behavior.

## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project maintainers at:

* [Joan Giner](https://github.com/JoanGi/) (he/him)
* [Abel Gómez](https://github.com/abelgomez/) (he/him)
* [Jordi Cabot](https://github.com/jcabot/) (he/him)

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.

## Enforcement Guidelines
Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning
**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct/

Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing to DescribeML

First of all, thank you for your interest in contributing to our project!

There are several ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved and how your contribution will be considered.

## Asking Questions

Do you have a question? Feel free to [open an issue](https://github.com/SOM-Research/DescribeML/issues/new?assignees=&labels=question&template=question.md).

Project maintainers will be eager to listen from you and help you out. Please, try to compose a clear and concise question. The more information you provide, the better we will be able to help you.

## Reporting Issues

Do you have you identified a reproducible problem in our code? or have a feature request? We want to hear about it! Please follow the next steps:

### Look For an Existing Issue

Sometimes the issue you want to report is being already addressed, or is planned to be addressed soon. Before you create a new issue, please do a search in [open issues](https://github.com/SOM-Research/HFCollection/issues) to see if the issue or feature request has already been filed.

If you find your issue already exists, do not hesittate to make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Please, use a reaction in place of a "+1" comment, we believe it's easy: 👍 for upvoting and 👎 for downvoting.

If you cannot find an existing issue that describes your bug or feature, [create a new issue](https://github.com/SOM-Research/DescribeML/issues/new?assignees=&labels=&template=proposal.md). The template will guide you on the issue reporting.

### Writing Good Bug Reports and Feature Requests

Whenever possible, we ask you to file a single issue per problem and feature request. Please do not enumerate multiple bugs or feature requests in the same issue, as it may be hard to track the progress.

As you can imagine, the more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.

### Creating Pull Requests

Please refer to the article on [creating pull requests](https://github.com/microsoft/vscode/wiki/How-to-Contribute#pull-requests) before contributing to this project.

### Governance

Any contribution you send to us will be addressed by the project maintainers following the governance rules described in the [GOVERNANCE.md](GOVERNANCE.md)

# Thank You!

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.
Binary file removed DescribeML-0.0.5.vsix
Binary file not shown.
Binary file removed DescribeML-0.0.6.vsix
Binary file not shown.
Binary file removed DescribeML-0.0.8.vsix
Binary file not shown.
41 changes: 41 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Project Governance

The development and community management of the project will follow the governance rules described in this document.

## Project Maintainers

Project maintainers have admin access to the GitHub repository. The team of project maintainers is the following:

* [Joan Giner](https://github.com/JoanGi/) (he/him)
* [Abel Gómez](https://github.com/abelgomez/) (he/him)
* [Jordi Cabot](https://github.com/jcabot/) (he/him)

## Project Collaborators & Contributors

Any member willing to participate in the development of the project will be considered as a collaborator.

Collaborators may propose changes to the project's source code. The mechanism to propose such a change is a GitHub pull request. A collaborator proposing a pull request is considered a contributor. Project maintainers will review and merge pull requests.

## Issue governance

Both collaborators and project maintainers may propose issues. Participation in the issue discussion is open and must follow the [Code of Conduct](CODE_OF_CONDUCT.md).

The group of project maintainers will be responsible for assigning labels to issues, as well as assign the issue to a project maintainer or contributor.

The group of project maintainers commits to answer to any issue in a period of time of 3 weeks.

## Pull Request governance

Both collaborators and project maintainers may propose pull requests. When a collaborator proposes a pull request is considered a contributor.

Pull requests should comply with the template provided. The assignment of labels and assignees to the pull request is the responsibility of the project maintainers.

The group of project maintainers commis to answer to any pull request in a period of time of 3 weeks.

The decision of accepting (or rejecting) a pull request will be taken by the group of project maintainers. The decision will be based on the following criteria:

* One project maintainer must approve a pull request before the pull request can be merged.
* One project maintainer approval is enough if the pull request has been open for more than 14 days.
* Approving a pull request indicates that the contributor accepts
responsibility for the change.
* If a project maintainer opposes a pull request, the pull request cannot be merged (i.e., _veto_ behavior). Often, discussions or further changes result in collaborators removing their opposition.

0 comments on commit a49cbcf

Please sign in to comment.