Developing for Openscholar

Creating a issue

Context: explain the conditions which led you to write this issue.

For example: "When adding a menu entry in the newest version of OpenScholar 3.23 I get redirected to the homepage."

Problem or idea: the context should lead to something, an idea or a problem that you’re facing.

For example: "We have no way of telling if the menu entry was added correctly."

Solution or next step: this where you move forward. You can engage others, leave for further investigation, or propose a plan.

For example: "You should be brought back to the menu configuration and shown the new menu entry in the menu."

Submitting a code patch for an issue

If you are a member of the OpenScholar organization

For issues which you would like to contribute or which you have been assigned, you should:

• Mark the issue 'status: in dev' when you start working on it
• Create a separate branch off of the root branch (SCHOLAR-3.x). The branch should be named with the issue number first followed by some short descriptive text. ex. (2342-menu-fatal)
• When your branch is ready for review, you should create a PR for your branch against SCHOLAR-3.x
• This will initiate automated tests, and you can mark the issue 'status: needs review' to flag it for code review
• It will then either be marked back in dev if there are issues, or changed to 'status: needs qa'
• It will then either be marked back in dev if it fails QA, or changed to 'status: fixed'
• After it is fixed and passing tests, the PR will be merged into the dev branch.

For users without access to the repository

The process is similar to above, however instead of creating a separate branch you will clone the entire repository. When your changes are ready you will submit a PR with your cloned repo. Tests will be run on your behalf by an OpenScholar developer.