Project Onboarding

Welcome to the JWQL project! This page serves as a one-stop-shop for links to documentation and resources needed to effectively getting started and contributing to the project. New members of the project should review the following materials (in the recommended order):

1. Review the JWQL repository README, which covers:
   • A brief overview of the project
   • How to install the jwql conda environment and jwql package
   • How to perform software contributions
   • The jwql Code of Conduct
2. Become familiar with the jwql Style Guide
3. Become familiar with the git workflow for software contributions
4. Become familiar with the Checklist for Contributors

Additionally, for those members aiming to contribute to a certain aspect of the project, the following may be helpful:

• Web Application:
  • Review the presentation on django web applications
  • Try to get the web app running locally
  • Look over materials in the webpage_template branch
• Database:
  • Become familiar with the database_interface.py module and materials within the database/ subpackage
• Instrument Monitoring:
  • Check out the monitor_template.py module
  • Review the instrument monitoring overview innerspace page
  • Become familiar with how to perform logging

For JWQL Administrators:

• Add the new member as a collaborator to the jwql repository on GitHub
• Add the new member to the jwql innerspace space
• Ask ITSD to add the new member to the jwql_dev unix group
• Ask ITSD to add the new member to the jwql-dev-team and jwql-users AD groups
• Ask ITSD to add the new member to the list of sudo-ers for the jwql service account on the dev, test, and production servers (if necessary)
• Provide the new member with the paths to the filesystem, preview images, and thumbnails on central storage (for creating the necessary symbolic links for running the web app locally)
• Provide the new member with a copy of the config.json file.