Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 4.72 KB
Raw

How to Contribute

DSpace is a community built and supported project. We do not have a centralized development or support team, but have a dedicated group of volunteers who help us improve the software, documentation, resources, etc.

Contribute new code via a Pull Request

We accept GitHub Pull Requests (PRs) at any time from anyone. Contributors to each release are recognized in our Release Notes.

Code Contribution Checklist

  • PRs should be smaller in size (ideally less than 1,000 lines of code, not including comments & tests)
  • PRs must pass ESLint validation using yarn lint
  • PRs must not introduce circular dependencies (verified via yarn check-circ-deps)
  • PRs must include TypeDoc comments for all new (or modified) public methods and classes. Large or complex private methods should also have TypeDoc.
  • PRs must pass all automated pecs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • User interface changes must align with Accessibility guidelines
  • PRs must use i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • Details on how to test the PR must be provided. Reviewers must be aware of any steps they need to take to successfully test your fix or feature.
  • If a PR includes new libraries/dependencies (in package.json), then their software licenses must align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • Basic technical documentation should be provided for any new features or configuration, either in the PR itself or in the DSpace Wiki documentation.
  • If a PR fixes an issue ticket, please link them together.

Additional details on the code contribution process can be found in our Code Contribution Guidelines

Contribute documentation

DSpace Documentation is a collaborative effort in a shared Wiki. The latest documentation is at https://wiki.lyrasis.org/display/DSDOC

If you find areas of the DSpace Documentation which you wish to improve, please request a Wiki account by emailing wikihelp@lyrasis.org. Once you have an account setup, contact @tdonohue (via Slack or email) for access to edit our Documentation.

Help others on mailing lists or Slack

DSpace has our own Slack community and Mailing Lists where discussions take place and questions are answered. Anyone is welcome to join and help others. We just ask you to follow our Code of Conduct (adopted via Lyrasis).

Join a working or interest group

Most of the work in building/improving DSpace comes via Working Groups or Interest Groups.

All working/interest groups are open to anyone to join and participate. A few key groups to be aware of include:

  • DSpace Developer Team - This is the primary, volunteer development team. We meet weekly to review our current development project board, assigning tickets and/or PRs. This is also were discussions of the next release or major issues occur. Anyone is welcome to attend.
  • DSpace Community Advisory Team (DCAT) - This is an interest group for repository managers/administrators. We meet monthly to discuss DSpace, share tips & provide feedback back to developers. Anyone is welcome to attend.