Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

49 lines (39 loc) · 3.59 KB
Raw

Contributing

GeoBlacklight is a collaborative open source projects where contributions are ✨welcome✨. This contributing guide is borrowed in part from the Samvera Contributing Guide and the Blacklight Contributing Wiki.

Who can contribute?

Anyone is welcome to contribute to GeoBlacklight. We follow a set of contribution practices to maintain a technically sustainable and stable software project for everyone.

Reporting issues

Did you find a bug in GeoBlacklight or interested in a new feature? Make sure to add an issue for it in the issue tracker.

  • Make sure you have a GitHub account
  • Submit a GitHub issue by:
    • Clearly describing the issue
    • Provide a descriptive summary
    • Explain the expected behavior
    • Explain the actual behavior
    • Provide steps to reproduce the actual behavior

GeoBlacklight Software Versioning

GeoBlacklight follows the practice of Semantic Versioning for software releases. The declared semantically versioned public API includes:

Contributing code or documentation

GeoBlacklight welcomes code and documentation contributions. You do not need to be a "GeoBlacklight Committer" to contribute code or documentation. We follow the pull request model for contributing on GitHub. GeoBlacklight uses a suite of tests to express its features and protect from bugs:bug:.

When proposing major new features or changes that may introduce an API or schema change, please make sure to communicate with the community so the full implications are understood. Likely there are ways to introduce these changes in a backwards compatible way that others may be able to help with.

Pull request overview

  1. Fork it ( http://github.com/my-github-username/geoblacklight/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Merging Changes

  • It is considered "poor form" to merge your own request.
  • Please take the time to review the changes and get a sense of what is being changed. Things to consider:
    • Does the commit message explain what is going on?
    • Does the code changes have tests? Not all changes need new tests, some changes are refactorings
    • Do all new methods, modules, and classes have comments? Do changed methods, modules, and classes have comments?
    • Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
    • Did the Travis tests complete successfully?
  • If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
  • If you like the pull request, but want others to chime in, create a +1 comment and tag a user.

If you wish to ask questions or participate further, email the GeoBlacklight Working Group at [email protected].