Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (30 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

51 lines (30 loc) · 2.83 KB

Contributing to NeuronAI Framework

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Contributor License Agreement (CLA)

By contributing to this project (e.g., submitting a Pull Request), you agree to the following terms:

  1. Copyright Assignment: You hereby assign to Inspector SRL ("Project Owner") all right, title, and interest in and to your contribution, including all copyright and intellectual property rights.
  2. Grant of Rights: If for any reason the assignment in section 1 is ineffective, you hereby grant to Inspector SRL a perpetual, irrevocable, exclusive, worldwide, royalty-free license to use, reproduce, modify, display, perform, sublicense, and distribute your contribution.
  3. Originality: You represent that the code you are contributing is your original creation and that you have the right to assign or grant these rights to Inspector SRL.

The following is a set of guidelines for contributing to the Neuron AI Framework. These are mostly guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.

I don't want to read this whole thing, I just have a question!!!

Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.

How can I contribute?

Reporting Bugs

When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

  • Update to the Latest Version. You might be running into an issue which was already fixed in a more recent version of the package than the one you're using.
  • Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

Open a Pull Request

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Suggest your change to the repository's maintainer, or send an email at support@inspector.dev
  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Thanks! ❤️ ❤️ ❤️

Inspector Team
⚡