Welcome to the pelicun developer guide. The following pages contain information on setting up a development environment, our code quality requirements, our code of conduct, and information on the submission process. Thank you for your interest in extending pelicun. We are looking forward to your contributions!

1. Getting started

1.1. Code of conduct

1.1.1. Our pledge

We as members, contributors, and leaders pledge to make participation in 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, socioeconomic 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.

1.1.2. Our standards

Examples of behavior that contributes to a positive environment for our community include:

Demonstrating empathy and kindness toward other people.
Being respectful of differing opinions, viewpoints, and experiences.
Giving and gracefully accepting constructive feedback.
Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
Focusing on what is best not just for us as individuals, but for the overall community.

Examples of unacceptable behavior include:

The use of sexualized language or imagery, and sexual attention or advances of any kind.
Trolling, insulting or derogatory comments, and personal or political attacks.
Public or private harassment.
Publishing others’ private information, such as a physical or email address, without their explicit permission.
Other conduct which could reasonably be considered inappropriate in a professional setting.

1.1.3. Enforcement responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders 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, and will communicate reasons for moderation decisions when appropriate.

1.1.4. Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

1.1.5. Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leader responsible for enforcement at adamzs@stanford.edu. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

1.1.6. Enforcement guidelines

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

1.1.6.1. 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.

1.1.6.2. 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.

1.1.6.3. 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.

1.1.6.4. 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.

1.1.7. Attribution

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

Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

1.2. How to contribute

1.2.1. Prerequisites

Contributing to pelicun requires being familiar with the following:

1.2.2. Contributing workflow

The development of pelicun is done via Pull Requests (PR) on GitHub. Contributors need to carry out the following steps to submit a successful PR:

Create a GitHub account, if you don’t already have one.
Fork the primary pelicun repository.
On the fork, create a feature branch with an appropriate starting point.
Make and commit changes to the branch.
Push to your remote repository.
Open a well-documented PR on the GitHub website.

If you are working on multiple features, please use multiple dedicated feature branches with the same starting point instead of lumping them into a single branch. This approach substantially simplifies the review process, and changes on multiple fronts can be easily merged after being reviewed. On each feature branch, please commit changes often and include meaningful commit titles and messages.

Tip

Consider taking advantage of advanced Git clients, which enable selective, partial staging of hunks, helping organize commits.

1.2.3. Code review process

After you submit your PR, we are going to promptly review your commits, offer feedback and request changes. All contributions code need to be comprehensive. That is, inclusion of new objects, methods, or functions should be accompanied by unit tests having reasonable coverage, and extension of the documentation pages as appropriate. We will direct you to extend your changes to cover those areas if you haven’t done so. After the review process, the PR will either be merged to the main repository or rejected with sufficient justification.

We will accept any contribution that we believe ultimately improves pelicun, no matter how big or small. You are welcome to open a PR even for a single typo.

1.2.4. Identifying contribution opportunities

The Issues page on GitHub documents areas needing improvement. If you are interested in becoming a contributor but don’t have a specific change in mind, feel free to work on addressing any of the issues listed. If you would like to offer a contribution that extends the fundamental framework, please begin by initiating a discussion before you work on changes to avoid making unnecessary effort.