👍🎉 First off, thanks for taking the time to contribute! 🎉👍
We welcome contributions via both the raising of issues and submitting pull requests. But before you do, please take a moment to review the following.
If before contributing, you would first like to discuss an issue or update then please come and have a chat with us on one of the following platforms:
- Users mailing list - Most active, best for more usage centric questions
- Developer mailing list - For discussing work on the code
- #Equella channel in Apereo's slack
Issues relating to the documentation are welcome. (For any issues relating to openEQUELLA itself, please switch over to its repo.)
When raising issues, please try and be as detailed as possible. Links, line numbers, etc always welcome.
As per standard Apereo projects: If you wish to contribute to openEQUELLA itself, you should first subscribe to the openEQUELLA Google Group as outlined above and discuss your contributions with the other developers. You will also need to sign a Contributor License Agreement.
But after that, as per usual GitHub, please first fork the project and then branch off master and
use a 'feature' branch.
Please ensure you provide quality commit messages, and in the PR please detail what testing you have undertaken.
The site is served up by GitHub pages and is done so via a static Jekyll site. As a result, you can readily run it locally.
As you make changes, it's best if you preview locally to see how they look. To do this you have three main options:
- Simply push your branch and review on GitHub; or
- Run up a docker image; or
- Use the standard Jekyll pipeline to build and review.
The first needs no explanation, but as for the last two.
Before doing this, obviously you'll first need to have docker installed. That is outside the scope of this document, but instructions can be found at: https://docs.docker.com/install/
Once installed you can go to your project directory and execute:
docker run -t --rm -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages
Following which you should be able review your changes at http://localhost:4000/.
This relies on you having ruby and bundler installed on your machine. Use your system's method for
installing ruby, and then use gem to ensure you have system level bundler installed, e.g.
$ gem install bundler
Once you've done that, go into the project's directory and install the dependencies and then serve up the content with the local server:
$ bundle install --path vendor/bundle
$ bundle exec jekyll serve
As you then edit and save files, you should find the site is rebuilt automatically and you can browse at http://localhost:4000/.