CONTRIBUTING.md

Contributing to Parquet.Net

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

1. Where do I go from here?

If you've noticed a bug or have a question see if someone else in the community has already created a ticket. If not, go ahead and make one!

2. Fork & create a branch

If this is something you think you can fix, then fork parquet-dotnet and create a branch with a descriptive name.

If you need a started guide to understand Parquet format please read this guide

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

git checkout -b 325-add-japanese-translations

3. Get the fix 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. We will not accept any code (unless it's a trivial change or documentation) without any tests because we won't know if it fixes anything at all.

4. 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:parquet-dotnet.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

GitHub Actions CI will run our test suite against all supported scenarios. I 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 in CI. Especially because it checks on various OSes and .NET versions. In that case you can go ahead and investigate what's wrong and make appropriate fixes.