-
Notifications
You must be signed in to change notification settings - Fork 8
Contributing
Orthodox Presenter prides itself on being and remaining Open Source. We want to keep it as easy as possible to contribute changes that increase and enhance its functionality. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things and ensuring that things remain organized.
Orthodox Presenter and JSON
Orthodox Presenter is intentionally very modular and extensible. Documents are written in JSON and each file is organized in a specific manner. To get a sense of how documents are organized, you can go to docs and take a look at how the documents are arranged.
Here is a list of some of the directories where documents are placed:
- /docs/hymns - The directory that contains items that are hymns (e.g. Hymn of Blessing, O King of Peace, Aspasmos) as well as doxologies.
- /docs/prayers - The directory that contains items that are prayers (e.g. Prayer of Reconciliation, Anaphora, Thanksgiving Prayer) as well as certain deacon responses.
As you will find, there are subdirectories within the two listed above that house the relevant content.
This section entails information on how you can submit a bug report for Orthodox Presenter. Following the guidelines below will ensure that the bug is well understood and reproducible.
Submitting a detailed bug report
- Use a concise and descriptive title for the bug or issue to identify the problem.
- Be descriptive and explain the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Orthodox Presenter, e.g. which menu you were in, what date the calendar was set to, etc.
- Give multiple and specific examples of the issue. For example, if the issue is related to a certain litany that should be prayed on a specific day, list several days in those examples that are related to the issue.
- Explain in detail why this behavior is a bug.
- Use the Chrome Developer Tools to provide further insight into the issue that you are facing.
- Include screenshots and any other applicable items that may aid in the reproduction of said issue.
- Include what browser you were using as well as the version.
This section entails information on how you can submit a feature request for Orthodox Presenter. Following the guidelines below will ensure that the feature is well-understood by the maintainers.
Submitting a detailed feature request/suggestion
- Use a concise and descriptive title for the feature that is requested.
- Be descriptive with the feature request. For example, if the request is in regards to a specific user feature, mention which user it would be for, e.g. inaudible priest items collapse by default. Don't just mention the user and say the feature but describe how the feature or suggestion would be used.
- Explain why this enhancement, suggestion, or feature would be beneficial.
This section entails information on how you can submit a pull request to add content to Orthodox Presenter. Following the guidelines below will ensure that the pull requested is approved and added in a timely manner.
Submitting a pull request
Content Format
- All documents must be written in JSON.
- Abide by the Document Schema
- Be written in Unicode and use FreeSerifAthansius as the Coptic Unicode font.
- Follow the Pull Request template, ensuring to fill it out with as many deatils as possible.
JSON Conventions
There are a few conventions that we have put in place:
- The title of the document should be descriptive as possible without exceeding 20 characters.
Example
litany_clergy.json
- The naming scheme should go from narrow to broad.
Example
anaphora_stbasil.json