Contributing

Contributing to Aperta

We welcome contributions to Aperta.

Questions?

At the moment, the best place to contact us about Aperta is to file an issue. We will be monitoring the issues to ensure that you receive a prompt response.

Filing issues

If you encounter a bug or issue, please file a issue

Enhancement ideas or suggestions

If you have ideas for enhancement, please file an issue.

Running Aperta locally

Please see the README for information on getting a local setup of Aperta up.

Filing Pull Requests

Aperta is a complex project. If you have an idea for a change, you will probably want to explore our wiki to get an idea of how something has been designed. If you have questions, please open an issue.

That said, we are always open to pull requests. There is a long template that may not be relevant to you - please answer as best you can.

We will evaluate and provide feedback to any pull requests submitted.

Documentation

This wiki contains developer documentation only.

Contributing to the wiki

By default, editing the wiki is limited to users with the collaborator role, or to users expressly authorized by the admin/owner. This is to prevent spam. Please open an issue to ask for permission to edit the wiki.

TODO

Letter Templates
New journal creation
Card Config
Client-side HTML diffing in manuscript versions view (noop in pdf-only journal)
User Roles and Permissions

Tests

Our policy is that all code must pass all tests before merging to master. Our tests are run in CircleCI. See Testing for more information about writing tests.

Review

All code in Aperta goes through a review process. This is intended to ensure that Aperta is high quality code and is not intended to be hostile or negative.