Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 2.04 KB

contributing.md

File metadata and controls

66 lines (38 loc) · 2.04 KB

Contributing

We are open to and grateful for, any contributions made by the community. By contributing to panopticon, you agree to abide by the code of conduct.

Reporting Issues and Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Development

Visit the Issue tracker to find a list of open issues that need attention.

Fork, then clone the repo:

git clone https://github.com/your-username/panopticon.git

Another way is to use gitpod:

https://gitpod.io/#https://github.com/paranatural/panopticon

Structure

...

README.md

...

Tests

...

Type tests

...

New Features

Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

Before opening a feature request, please read the exists ideas discussions to make sure your feature hasn't already requested.

Publishing

...

Submitting Changes

  • Open a new issue in the Issue tracker.
  • Fork the repo.
  • Create a new feature branch based on the master branch.
  • Make sure all tests pass and there are no linting errors.
  • Please, write a good commit message, explaining why not how.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!

forked from effector contributing guide https://github.com/effector/effector/blob/master/CONTRIBUTING.md