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 development starts
• If the issue is missing requirements or need more specifications, mark is as 'status : needs specifications'
• 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)
• The behat test cases should be updated to match the changes made to the code
• Once development is complete, the code should be checked in into the branch
• When your branch is ready for review, create a PR for the branch against SCHOLAR-3.x
• This will initiate automated tests and once the tests pass, the issue should be marked as 'status: needs review' to flag it for code review
• Feedback to the code review will be made in the PR itself
• It will either be marked back as 'status: in dev' if there are issues, or changed to 'status: needs qa'
• The issue will then be marked back as 'status: in dev' if it fails QA. Comments after QA will be added to the issue in github. If it passes QA, the status will be changed to 'status: fixed'
• After it is fixed and passing tests, the PR will be merged into the dev branch and the issue will be closed.

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.