In no particular order, here are some hints/tips to help introduce a new Committer to the DSpace Development process:
Committer Mailing Lists
- email@example.com : As a new committer, you will be added to the private 'dspace-commit' listserv. We try to only use this 'dspace-commit' list for administrative duties or official nominations/votes for committership, etc. Developer topics occasionally come up here as well, but once they begin to move beyond "administrative" we try to move them to 'dspace-devel' so the entire DSpace Developer Community has input.
- firstname.lastname@example.org : If you are not already aware of it, we have a public 'dspace-changelog' email list which just reports recent commits to GitHub. You may want to join this if you want to be notified of all commits merged into "main" branches, etc.
- email@example.com: (NO LONGER USED AS JIRA IS RETIRED) Again, if you are not already aware of it, we have a public 'dspace-tickets' email list which just reports any recent changes to JIRA tickets. You should probably join that list, as it is also your friend.
The Tools We Use
Here's a current list of the tools/sites we use, and how they are used.
- GitHub - The main codebases & issue tracker are here. We also distribute our releases from here.
- GitHub Actions for CI - We use GitHub Actions to do all Continuous Integratoin checks, including validating PRs & running automated tests. See Continuous Integration for more details.
- DSpace Wiki- The public wiki space. A few areas to be aware of (if you are not already)
- DSpace Documentation- The official DSpace documentation is created in the wiki (and PDFs are generated from the wiki during releases). This is the splash page which lists all the existing DSpace Wiki Documentation.
- How we generally manage this Documentation is on a subpage: Documentation Management
- demo6.dspace.org - The demo installation of DSpace (6.x) which is on a virtual server (Amazon EC2 w/Ubuntu Linux). This server can be used as a resource for those upgrading from DSpace 6.x to 7.x. More info at demo6.dspace.org Notes
- www.dspace.org - Main website which is managed by Lyrasis. If you need something changed/updated there, contact
Regarding commits to GitHub:
- As a new Committer, you obviously have full rights to commit code. Usually, we try to not commit major code to DSpace that has not be reviewed by others (by posting a GitHub Pull Request and JIRA ticket for review). But, obviously minor bug fixes/typos can just be fixed immediately – there's no need to review things that are obvious.
- Please review to the Guidelines for Committing for additional hints/tips on our normal commit process.
- Also read Development with Git for some hints/tips on GitHub development practices
There are actually several projects in GitHub (in case you haven't browsed around it much). Here's a very brief overview of the main projects available off of https://github.com/DSpace/
- DSpace- The main codebase. The backend for 7.x and above
- dspace-angular - The frontend/UI for 7.x and above.
- dspace-api-lang - The DSpace API/JSPUI Language Packs, which are released separately to Maven Central (so DSpace can use it as a dependency & include it out-of-the-box).
- These are still used in 7.x for a few backend tasks, but the UI level language packs are now a part of "dspace-angular" (see above)
- dspace-xmlui-lang (6.x and below only) - The DSpace XMLUI Language Packs, which are released separately to Maven Central (so DSpace can use it as a dependency & include it out-of-the-box)
- dspace-solr (6.x and below only) - Special, slightly customized version of Solr, which is released separately to Maven Central (so DSpace can use it as a dependency & include it out-of-the-box)
- dspace-cocoon-servlet-service-impl (6.x and below only) - Patched version of Cocoon Servlet Service which resolves issues with Cocoon swallowing 404 Errors, which is released separately to Maven Central (so DSpace can use it as a dependency & include it out-of-the-box)
Questions / Issues
- If you have questions – definitely feel free to ask. We are a very friendly group. Although there is the occasional disagreement, no one gets offended, and I think we always end up with a friendly resolution.
- If you are trying to do something with anything related to DSpace (GitHub, Wiki, etc.) and you cannot figure it out or it isn't working, let us know! Chances are we forgot to give you some permissions that you need to have (or something is broken).
- Similarly, if you really aren't sure about an "official policy on ____" or have questions on Committership in general, please ask. In most cases, either there is no "official policy" (but there may be guidelines), or we forgot to document it. Either way, it's helpful to point it out to us, so that we can avoid confusing new committers in the future!
- In the end, it comes down to three things:
- Have fun! Really – no need to take it too seriously.
- We don't really have any strict "rules", just occasional "guidelines"
- Ask questions if things are not clear – any of us are glad to help.