Skip to content

contributing.md

Latest commit

 

History

History
76 lines (53 loc) · 2.57 KB

contributing.md

File metadata and controls

76 lines (53 loc) · 2.57 KB

Contributing to DataFrames

First off, thank you for considering contributing to DataFrames. It's people like you that make it such a great library.

1. Fork & create a branch

First of all, fork DataFrames and create a branch with a descriptive name.

A good branch name would be (where issue #325 is the ticket you're working on):

git checkout -b 325-add-japanese-translations

2. Get the fix or feature working

Make the changes and make sure they are working locally. In case of code changes we strongly advise to create a unit/integration test before finishing your work.

Please don't forget to add appropriate documentation for public interfaces and when required into markdown files.

3. Make a Pull Request

At this point, you should switch back to your master branch and make sure it's up to date with Parquet.Net master branch:

git remote add upstream git@github.com:dataframe-utils.git
git checkout master
git pull upstream master

Then update your feature branch from your local copy of master, and push it!

git checkout 325-add-japanese-translations
git rebase master
git push --set-upstream origin 325-add-japanese-translations

Finally, go to GitHub and make a Pull Request :D

AppVeyor CI will run our test suite against all supported scenarioss. We care about quality, so your PR won't be merged until all tests pass. It's unlikely, but it's possible that your changes pass tests on your machine but fail on AppVeyor. In that case you can go ahead and investigate what's wrong as we keep the build logs open.

4. Keeping your Pull Request updated

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

To learn more about rebasing in Git, there are a lot of good resources, but here's the suggested workflow:

git checkout 325-add-japanese-translations
git pull --rebase upstream master
git push --force-with-lease 325-add-japanese-translations

5. Merging a PR (maintainers only)

A PR can only be merged into master by a maintainer if:

  • It is passing CI.
  • It has been approved by at least two maintainers. If it was a maintainer who opened the PR, only one extra approval is needed.
  • It has no requested changes.
  • It is up to date with current master.

Any maintainer is allowed to merge a PR if all of these conditions are met.