Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

70 lines (44 loc) · 2.04 KB
Raw

Contributing Guidelines

General

  • Contributions of all kinds (issues, ideas, proposals), not just code, are highly appreciated.
  • Pull requests are welcome with the understanding that major changes will be carefully evaluated and discussed, and may not always be accepted. Starting with a discussion is always best!
  • All contributions including documentation, filenames and discussions should be written in the English language.

Issues

Our issue tracker can be used to report issues and propose changes to the current or next version of this connector.

Contribute Code

Relevant Docs

Readme for the data.world target

Fork the Project

Fork the project on Github and check out your copy.

$ git clone https://github.com/[YOUR_GITHUB_NAME]/knots-heroku-recipe.git
$ cd knots-heroku-recipe
$ git remote add upstream https://github.com/datadotworld/knots-heroku-recipe.git

Write Tests

Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.

We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.

Write Documentation

Document any external behavior in the README.

Commit Changes

Make sure git knows your name and email address:

git config --global user.name "Your Name"
git config --global user.email "contributor@example.com"

Writing good commit logs is important. A commit log should describe what changed and why.

git add ...
git commit

Push

git push origin my-feature-branch

Make a Pull Request

Go to https://github.com/[YOUR_GITHUB_NAME]/knots-heroku-recipe.git and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.

Thank you!

Thank you in advance for contributing to this project!