We welcome pull requests from everyone. By participating in this project, you agree to abide by the code of conduct.
Geneac is a genealogy CMS (Content Management System) built on Ruby on Rails.
As much as possible Geneac attemps to do things "The Rails Way." To that end, the best way to learn about Ruby on Rails is the official Rails documentation.
A few key libraries/gems that would also be helpful to learn about before contributing would be:
Finally, since Heroku is the primary deployment target, I also recommend reading about twelve-factor apps.
- Fork the repo,
- Complete the setup for local development, outlined below,
- Run the test suite with
rake
, - Make your changes,
- Push your fork and open a pull request.
A good PR will solve the smallest problem it possibly can, have good test coverage and (where necessary) have internationalisation support.
You can find the most up-to-date instructions for running the application locally on the documentation website.
The application's source code lives in the app
and lib
subdirectories.
The application test code (the 'spec') lives in the spec
subdirectory.
For security inquiries or vulnerability reports, please email mitchell.rysavy@gmail.com.