Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The initial goal will be to create a like for like version of the current UIs: by which we mean:
    • everything that's possible with the current UIs should also be possible with ours
    • we don't want to put a lot of effort in implementing new features
  • That doesn't mean that everything should look and behave exactly as it does now
  • But take your inspiration from the current UIs if you don't have a particular reason to do it differently

 

How to contribute

...

  • Prerequisites

    • You'll need to be in the dspace-angular github team to get the required access. Send your github username to Art Lowel (Atmire)

...

    •  to get an invite.

...

    • Fork the repository on Github
  • Workflow
    • Have a look at the waffle board

    • Take an issue that’s in the ready section and has nobody assigned to it

    • assign yourself

    • When you start working on it, move the issue to the “in progress” section

    Fork the project on github, work on
    • Work on a separate branch for the issue on your fork

    • When you’re ready, fire a pull request

    • in the comments of the pull request, write something akin to “this PR connect’s to #{the ID of the issue}”. That way the issue will be moved automatically to the review column.

    • When at least two people have reviewed and approved your PR, it can be merged in master.

    • You can also help out by reviewing the pull requests of other people

    • Please keep an eye on your pull request afterwards, the reviewers may have questions or comments about it, or ask you to tackle things in a different way, before they can approve it

    • Most discussions about the task or the pull request can happen through the github & waffle board comments.

    • If it’s more complex you can bring it up in one of these meetings.

    • After your Pull Request has been merged, drag the issue to the done column on the waffle board. (this can also be automated by adding “this merge closes #{the id of the issue}” in the merge comment.

 

Documentation

  • We'll need information on the wiki to help people learn angular 2 and universal development
  • We'll need to properly document the development process on the wiki, perhaps starting from the "how to contribute" list above
  • Our best practices and code standards also need to be added.
  • We need a complete list of features we aim to achieve in DSpace 7 listed publicly, not just on the waffleboard
    • Perhaps we can ask DCAT to help with this
    • This is an opportunity to also link up features with the Use Cases that DCAT gathered. Some use cases may be easily implemented in Angular that were NOT as easily achieved in existing UIs
    • We can then more easily draw from this master list to create new tickets in Waffleboard for each work package 

...