Skip to content

Latest commit

 

History

History
60 lines (30 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

60 lines (30 loc) · 3.28 KB
Raw

Contributing to ESP

Looking to contribute to ESP? The ESP team welcomes external contributions and collaborations! Here's how you can help.

ESP documentation

The best way to get started with ESP is the fastly growing set of guides and video tutorials on the ESP website.

You can stay up to date with ESP's new features by:

Issue tracker

The issue tracker is the preferred channel for bug reports, feature requests and pull requests.

  • Please keep the discussion on topic and respect the opinions of others.

  • Please do not use the issue tracker for personal support requests. Use the contact email esp-info(at)lists.cs.columbia.edu instead.

  • Please try to use the proper label when opening an issue. We reserve the right to change or add labels as appropriate.

Bug reports

Good bug reports are extremely helpful!

  • Whenever appropriate, we suggest the use of the issue templates for bug reports and feature requests.

  • Use the GitHub issue search to check if the issue has already been reported.

Feature requests

Feature requests are welcome. We are a small research team, but we will do our best to address them if we see fit. Please provide as much detail and context as possible to make your case about the merits of the feature.

Pull requests

Good pull requests are really helpful! We suggest you contact us before embarking in significant work toward a pull request, if we coordinate early the merge process will be more timely and successful.

Here are some guidelines for contributing:

  • Never push to master. Instead, create a new branch starting from master for your work and use that branch to develop and test your feature or bugfix.

  • To merge your work to ESP create a Pull Request to discuss your work with the repository owner.

  • The quality of the Git commits description is important. Write descriptive git commit messages. Here is an article with detailed guidelines.

  • Before opening a Pull Request rebase your branch to create meaningful commits, squashing multiple commits that jointly implement a feature or bugfix and removing commits that are not relevant.

  • The Pull Request review may take a few iterations and we may ask you to make changes to your commits.

  • ESP is a fairly complex repository. Try to get a good undestanding of ESP's structure so that your work will fit right in and you will be able to use any existing feature that you might need.

License

By contributing your code, you agree to license your contribution under the Apache License 2.0 as described in the ESP license document.