Contributing to lynguine

First off, thank you for considering contributing to lynguine! It’s people like you that make ndlpy such a great tool.

Code of Conduct

This project and everyone participating in it are governed by the ndlpy Code of Conduct. By participating, you are expected to uphold this code.

I Don’t Want to Read This Whole Thing!

That’s okay! Here’s what you need to know:

  • For minor fixes like typos, feel free to send a pull request.

  • For major changes or new features, please open an issue first to discuss what you would like to change.

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.

  • Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.

  • Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

How Can I Contribute?

Reporting Bugs

Before submitting a bug report, please check that it hasn’t already been reported. If you’re unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

Enhancement suggestions are also tracked as GitHub issues. When you are creating an enhancement issue, please include:

  • A clear and descriptive title.

  • A detailed description of the proposed feature.

  • An explanation of why this enhancement would be useful to most ndlpy users and isn’t something that can or should be implemented as a community extension.

Your First Code Contribution

Unsure where to begin contributing to ndlpy? You can start by looking through the ‘beginner’ and ‘help-wanted’ issues:

  • Beginner Issues - issues which should only require a few lines of code, and a test or two.

  • Help Wanted Issues - issues which should be a bit more involved than beginner issues.

Pull Requests

The process described here has several goals:

  • Maintain lynguine’s quality

  • Fix problems that are important to users

  • Engage the community in working toward the best possible lynguine

  • Enable a sustainable system for ndlpy’s maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow the style guides

  2. After you submit your pull request, verify that all status checks are passing

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Style Guides

  • Use the present tense (“Add feature” not “Added feature”)

  • Use the imperative mood (“Move cursor to…” not “Moves cursor to…”)

  • Limit the first line to 72 characters or less

  • Reference issues and pull requests liberally after the first line

All Python code should adhere to the PEP 8 style guide.