Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 2.39 KB
Raw

How to contribute

I'm really glad you're reading this, thanks.

The following is a set of guidelines for contributing to pkb. Use your best judgment, and feel free to propose changes to this document or any other community document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the pkb Code of Conduct. Please report any unacceptable behavior to @gfarfanb.

Getting started

To start using this repository right away, fork this repository on GitHub.

How can I contribute in a different way?

Reporting bugs

  • Fill the required template.
  • Make sure you are correctly following the checklist section.
  • The description must be concise.
  • It is important the indicate environment you are testing.
  • Include screenshots and animated GIFs in your pull request whenever possible.

Suggesting enhancements

It is always welcome a new change idea, refactoring, design, features, new pages (not only posts), just propose it via feature requests or if consider better via pull requests.

Pull Requests

  • Fill the required template.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Describe every change you made in a new bullet.
  • End all files with a newline.
  • Do not forget to list the contributors.
  • Every pull request must have one review, must be up to date and must have verified signatures, so wait and process the feeback.

Once your pull request is ready to be merged, the repository maintainers will integrate it. There is no additional action required from pull request contributors at this point.

Copyright

pkb is licensed under Attribution-ShareAlike 4.0 International (CC BY-SA 4.0), with a few exceptions like pure executable code which uses MIT License. We consider all contributions as CC BY-SA or MIT unless it's explicitly stated otherwise. Any-incompatible code contributions will be rejected. Contributions under Any-compatible licenses may be also rejected if they are not ultimately necessary.