Hacking on Eventz core
If you’re hitting a bug in Eventz or just want to experiment with adding a feature to the core of the system, you’ll want access to a local copy of the Eventz source.
Fork the Eventz repository
Follow the GitHub Help instructions on how to fork a repo.
Cloning
The next is creating your own clone.
git clone git@github.com:your-username/eventz.git
Next install all the dependencies: cd eventzapi pip install -r requirements.txt
Installing modules
Development Mode
Use a python IDE to edit the package (e.g. PyCharm). Eventz is an API to be imported into an application. There are several test applications in the package that can be used to confirm the correct functioning of any modification.
Installing Dependencies
You’ll want to keep dependencies up to date by running pip install -r requirements.txt after pulling any upstream changes.
Pull Requests
The process described here has several goals:
-
- Maintain Eventz quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Eventz
- Enable a sustainable system for Eventz maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite. While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.