Skip to content
This repository has been archived by the owner on Mar 8, 2020. It is now read-only.

Latest commit

 

History

History
152 lines (106 loc) · 5.15 KB

CONTRIBUTING.md

File metadata and controls

152 lines (106 loc) · 5.15 KB

Contributing

Thanks for contributing!

Development

Installing dependencies

We use yarn.

Install all dependencies by running:

$ yarn

Running the Example Project

We have an in repo example project in the /example directory that can be used to test local changes to next-urql. The example works by packing a tarball of the src directory using yarn pack. All you need to do to get up and running is:

# Navigate to the example directory.
cd example

# Run the automated install script.
# This will handle setting up your dependencies correctly.
bash install_deps.sh

# Start the development server.
yarn dev

You can also follow the instructions in the example project's README.

Testing

Run tests using yarn test.

Linting, Formatting, and Type Checking

To lint your code from the command line:

yarn lint

To run Prettier over files from the command line and edit them in place:

yarn format

To check types:

yarn check:types

Before submitting a PR

Thanks for taking the time to help us make next-urql even better! Before you go ahead and submit a PR, make sure that you have done the following:

  • Consider if your changes should be incorporated in the current example project or a new one. Like a new feature, option, etc. Let's try out everything we add!
  • Add an ## UNRELEASED CHANGELOG.md entry for later publishing ease.
  • Check that all of the examples build: yarn build-examples.
  • Run all checks using yarn run check

Releasing a new version to NPM

Only for project administrators.

  1. Update CHANGELOG.md, following format for previous versions
  2. Commit as "Changes for version VERSION"
  3. Run npm version patch (or minor|major|VERSION) to run tests and lint, build published directories, then update package.json + add a git tag.
  4. Run npm publish and publish to NPM if all is well.
  5. Run git push && git push --tags

Contributor Covenant 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 parker.ziegler@formidable.com. 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