Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 6.48 KB

README.md

File metadata and controls

60 lines (42 loc) · 6.48 KB
Raw

EE People Add-on

Latest Release Travis License Event Espresso Addon Minimum EE Core Version:

The Event Espresso People add-on creates an interface for managing staff, instructors, speakers, volunteers, sponsors, or just about any type of role someone might fill within an event and/or organization.

Note, there is no usage support provided here. Please read the entire contents of this document before posting any issues. If we encounter issues that give evidence of this document not having been read the issue will be closed.

Some Links
Support License Support for this add-on is not provided through this repository. For support you can purchase a Premium Support License.
Documentation View Documentation →
Newsletter Be the first to know when we ship new features ... signup here.
Community Chat Join a real-time community chat group for professionals that are leading the way in events from event management, event technology and event marketing to work-life balance. Join the Discussion →

Developers

This is the full version of the add-on and provides its full feature set. The repository is provided to assist you with evaluating whether it will solve your use-case.

We ask if you are using this to provide a solution for clients that you (or your client) purchase a support license for this add-on.

No Usage Support is provided in this repository.

Add-on Releases and Development

We follow a set pattern for releases and development of all our official add-ons:

  1. Active development for new features happens on a FET-{ticket-number}-{brief-description} branch. We continually merge master into the feature branch while it's in development. Once it's complete, then testing is done on it and it's merged back to master ready for release.
  2. Bug fixes are done on a BUG-{ticket-number}-{brief-description} branch. Same methodology is used as with feature branches.
  3. Master is technically always production ready and release ready but may not be equal to what the current stable release is for.
  4. When we do an official release of an add-on, the current master is tagged and the release is the zip for that tag.

Testing

For all testers of this add-on, please take note of the following when reporting issues.

  1. There is a difference between a feature and a bug, we consider a bug is something that reveals brokenness in intended functionality. A feature, is something beyond intended functionality. To help determine the difference, think about your issue like this, "I know A does C, however I wish it did D." If you find yourself saying that, its a feature. This repository is not the place to suggest a new feature UNLESS you've already got a pull request to implement it (see pull requests section below). Info on sponsoring new features can be found here. If you aren't sure whether something is a feature or bug feel free to post the issue - however we give priority to bug issues here.

  2. UI/UX issues may be considered a bug but not if it requires a major change in design. Feel free to report things you find confusing or needing improvement however reports accompanied by a pull request will likely get faster attention.

  3. Report your issue as clearly as possible. By "clear" we mean:

    i. Specify the branch this occurred in.

    ii. Be specific about the steps you took to reproduce.

    iii. Feel free to use screenshots/screencasts to illustrate

    iv. Use URLs for the page the issue to place on where possible.

  4. Don't "bump" bug reports if we don't respond right away. We see every report coming in, but we'll only reply if we need clarification or if we think its invalid. Otherwise, we're likely working on a fix and the issue will be updated when the fix is complete.

Pull Requests

One of the reasons we created this private repo on GitHub is because we wanted to open up EE development to 3rd party developers who might want to contribute to the codebase. GitHub makes this really easy to do so via pull requests. If you don't know what pull requests are, please read up on them via the GitHub help/documentation.

Here's how we deal with pull requests for our repo:

  1. Any new FEATURES in a pull request should be based off of the master branch. If your feature pull request is based off any other branch it will not be considered.
  2. Any BUGFIX pull requests should be based off of the branch the bug was found. Please verify if it is in master before submitting the pull request. If it is in reproducible on master, then the pull-request should be based off of master.
  3. We greatly appreciate any pull-requests submitted for consideration, but please understand we are very selective in what we decide to include in our official add-ons. If the "feature" is something that expands too much on our design decisions for this add-on then we may suggest you develop your pull request into a different add-on for EE.

You may find our post on contributing to open source software helpful.