Contributing

Guidelines to contribute to this repository

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners 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.

Commits

When committing please always use the following pattern for you messages (scope, body and footer are optional):

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Commit message types (tags)
Release type
Example

feat: A new feature

Minor release (0.1.0)

feat: Add "Investment project" activity card

fix: A bug fix

Patch release (0.0.1)

fix: Remove default activity card

docs: Documentation only changes

None

docs(README): Add testing instructions

style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

None

style: Use tabs instead of spaces

refactor: A code change that neither fixes a bug nor adds a feature

None

refactor: Add missing props validation to ActivityFeed

perf: A code change that improves performance

None

perf: Improve rendering speed of ActivityFeed

test: Adding missing or correcting existing tests

None

test: Add integration tests to ActivityFeedCard

build Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)

None

build: Update webpack config

ci Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)

None

ci: Update CircleCI config

chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

None

chore: Update CircleCI config

To create a major/breaking (1.0.0) release, please add BREAKING CHANGE to the commit message body with some explanation, example message:

fix: Update flaky screenshot function.
BREAKING CHANGE: Update third party driver object.
Optionally add more info in the second line of your message.

Pull Request Process

  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. You may merge the Pull Request in once you have the sign-off of the mantainer, or if you do not have permission to do that, you may request the reviewer to merge it for you.

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 at [INSERT EMAIL ADDRESS]. 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

PreviousRunning testsNextPublishing

Last updated