Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.17 KB

How to contribute

Hello there. Looks like you are interested in contributing to PWSpy, which is just great, so welcome!

We are open to any kind of contribution: code, documentation, bug-fixing (even just reports), feature-requests and anything else you may come up with.

Getting started

Discussion

Please open an issue on the GitHub page for any discussion.

Contributing

Coding

Nothing fancy here, just:

  1. Fork this repo
  2. Commit you code
  3. Submit a pull request. It will be reviewed by maintainers and they'll give you proper feedback so you can iterate over it.

Considerations

Testing

As mentioned above, existing tests must pass and new features are required to be tested and fully-covered.

Documenting

Code should be self-documented. But, in case there is any code that may be hard to understand, it must include some comments to make it easier to review and maintain later on.