-
Notifications
You must be signed in to change notification settings - Fork 257
Contributing to Blacklight
So you've found a bug you want to fix, or a feature you want to implement, thanks!
If you follow this short guide, it will make it much easier for the community to review your changes, and the core team to get them included in the next release. If you are new to Git, be sure to read Github's (really good) step-by-step directions for contributing to projects. If you want a basic introduction to git, check out Git Reference.
We also encourage a lot of peripheral functionality -- especially for features that may not be used by most implementations, as the Blacklight install base has a wide range of users -- to consider developing stand-alone, optional Blacklight add-ons.
Let us know you're interested in working on a feature by filing a ticket in our JIRA tracker.
- Fork the project (Github has really good step-by-step directions
- Start a feature/bugfix branch
- Commit and push until you are happy with your contribution
- Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
- After making your changes, be sure to run the Blacklight rspec and cucumber tests to make sure everything works.
- Submit your change as a Pull Request and update your JIRA ticket to let us know it is ready for review.
If you are interested in working on the Blacklight plugin, but want guidance or support, please send an email to our Blacklight-development mailing list and we'll be glad to help.