Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create initial contributing guidelines #846

Merged
merged 1 commit into from
Jul 10, 2020
Merged

Create initial contributing guidelines #846

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing to Popup Maker

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

## Code of Conduct

This project and everyone participating in it is governed by the [Popup Maker Code of Conduct](https://github.com/PopupMaker/.github/blob/master/CODE_OF_CONDUCT.md). 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](https://github.com/PopupMaker/Popup-Maker/issues/new)
* 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](https://codex.wordpress.org/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