Skip to content

Latest commit

 

History

History
109 lines (75 loc) · 4.56 KB

CONTRIBUTING.md

File metadata and controls

109 lines (75 loc) · 4.56 KB

Contributing

Contributions are welcome. This project accepts pull requests on GitHub.

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.

Communication Channels

You can find help and discussion in the following places:

Reporting Bugs and Inaccurate Information

Report bugs and inaccurate information using the project's issue tracker.

Important

DO NOT include passwords or other sensitive information in your bug report.

When submitting a bug report, please include enough information to reproduce the bug. A good bug report includes the following sections:

  • Description

    Provide a short and clear description of the bug.

  • Steps to reproduce (if applicable)

    Provide steps to reproduce the behavior you are experiencing. Please try to keep this as short as possible. If able, create a reproducible script outside any framework you are using. This will help us to quickly debug the issue.

  • Expected behavior

    Provide a short and clear description of what you expect to happen or what is inaccurate about the information. Please include links to relevant sources to help us understand what is inaccurate.

  • Screenshots or output

    If applicable, add screenshots or program output to help explain the problem.

  • Environment details (if applicable)

    Provide details about the system where you're using this package, such as PHP version and operating system.

  • Additional context

    Provide any additional context that may help us debug the problem.

Fixing Bugs and Inaccurate Information

This project welcomes pull requests to fix bugs and inaccurate information!

If you see a bug report that you'd like to fix, please feel free to do so. Following the directions and guidelines described in the "Adding New Features" section below, you may create bugfix branches and send pull requests.

Adding New Features and Information

If you have an idea for a new feature or data, it's a good idea to check out the issues or active pull requests first to see if anyone is already working on it. If not, feel free to submit an issue first, asking whether the feature or data is beneficial to the project. This will save you from doing a lot of development work only to have your pull request rejected. We don't enjoy rejecting your hard work, but some features don't fit with the goals of the project.

When you do begin working on your feature, here are some guidelines to consider:

  • Your pull request description should clearly detail the changes you have made.
  • If adding new data to the data/ directory, please use data-template.yaml and follow the directions in it.
  • Use topic/feature branches. Please do not ask to pull from your main branch.
  • Submit one feature or data per pull request. If you have multiple features or data you wish to submit, please break them into separate pull requests.

Copyright and Public Domain Dedication

By contributing any work to the data/ directory, to the extent that you own the copyright and related rights in the work you are contributing, you voluntarily elect to apply CC0 (public domain dedication) to your work contributed to the data/ directory and publicly distribute your work under the terms of CC0, with knowledge of your copyright and related rights in your work and the meaning and intended legal effect of CC0 on those rights. For more details, please read the CC0 1.0 Universal Deed.

All work not contributed to the data/ directory (e.g., source code for managing and working with the data) is governed by the terms of the GNU Affero General Public License (AGPL), version 3, as published by the Free Software Foundation. By contributing your work to this project, you agree to license your work for others to use, modify, and distribute under the terms of the AGPL or other compatible license (as noted in your contribution).

See also the NOTICE file included with this software.