Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

45 lines (35 loc) · 1.95 KB
Raw

Contributing to Annolid

Thank you for your interest in contributing to Annolid! Before you begin writing code, please share your intention whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Developing Annolid

We use github to host code, to track issues and feature requests, as well as accept pull requests. Detailed instructions for installing Annolid is here https://annolid.com.

All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft and https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62