Skip to content
This repository has been archived by the owner on Nov 24, 2021. It is now read-only.

Latest commit

 

History

History
87 lines (54 loc) · 6.07 KB

CONTRIBUTING.md

File metadata and controls

87 lines (54 loc) · 6.07 KB

Contributing to Relaxed Lasso

This repository is maintained by the Continental Organization.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the maintainers of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Ways you can help

Helping others

You can help with code review, which reduces bugs, and over time has a wonderful side effect of making the code more readable and therefore more approachable. It's also a great way to teach and learn. Feel free to jump in! Be welcoming, appreciative, and helpful.

You can monitor issues and help other people who have questions about contributing to Relaxed Lasso, or using it for their projects.

Feel free to reach out to one of the maintainers if you need help getting started.

Suggesting improvements

If you have a suggestion of your own, search the open issues. If you don't see it, feel free to open a new issue.

Spreading the word

Feel free to star the repository. This will help increase the visibility of the project, therefore attracting more users and contributors to this repository !

Pull Request Process

If you want to work on this repository, you must fork the Continental repository first. Within your fork, it is possible to apply any changes and later push changes back to its origin.

Technically, you can contribute back to the Continental repository by creating a pull request. A member of the team will review this pull request and decide if it shall be integrated or not. If it shall be integrated, which can also be after some adaptions, a member of the team will merge the pull request into the intended branch.

However, a contribution can only be accepted if the following conditions are met during the pull request :

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
  4. Once you have the sign-off of at least one maintainer from the Continental organization, you may request the second reviewer to merge the Pull Request for you.
  5. Sign a Contributor License Agreement (CLA).

Concerning a pull request, feedback from the maintainers should usuallly be provided within a time frame of 10 working days.

Getting help

There are three places to get help:

  1. If you're new to the project, a good place to start is the README.
  2. Take a look at the examples and documentation.
  3. If you need help getting started or implementing a change, open an issue with your question. If there is already an issue open for the feature you're working on, you can post there.

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, gender identity and expression, level of experience, 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. 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, version 1.4, available at http://contributor-covenant.org/version/1/4