Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.98 KB
Raw

Contributing to Popup Maker

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

Code of Conduct

This project and everyone participating in it is governed by the Popup Maker Code of Conduct. By participating, you are expected to uphold this code.

Contributing

Community made feature requests, patches, localizations, bug reports, and contributions are always welcome and are crucial to ensure Popup Maker continues to grow.

When contributing please ensure you follow the guidelines below so that we can keep on top of things.

Commit Style

We strive to make all of our commits as great and useful as possible. Here are a few quick guidelines for any commits in this project:

  1. Have a "subject" line within your commit message limited to 50 characters
  2. Capitalize the subject line
  3. Use the imperative mood in the subject line
  4. Separate subject from body with a blank line
  5. Use the body to explain what and why vs. how
  6. Reference relevant GitHub issues

For further explaination and guidance, check out this great article on creating useful commit messages: https://chris.beams.io/posts/git-commit/

Creating Issues

  • If you have any bugs or feature requests, please create an issue
  • For bug reports, please clearly describe the bug/issue and include steps on how to reproduce it
  • For feature requests, please clearly describe what you would like, how it would be used, and example screenshots (if possible)

Pull Requests

  • Ensure you stick to the WordPress Coding Standards
  • When committing, reference your issue (if present) and include a note about the fix
  • Push the changes to your fork and submit a pull request to the 'master' branch of this repository
  • We are trying to ensure that every function is documented well and follows the standards set by phpDoc going forward