This repository serves as the single source of truth for all documentation and resources needed to collaborate effectively within the VIEWS organization. Whether you're onboarding, contributing to a project, or seeking guidance on workflows and standards, this is the place to start.
What you will find here:
- Organizational Standards: Comprehensive guidelines for coding practices, repository naming conventions, branch management, and project workflows.
- Organizational Decision Records (ODRs): A living record of key decisions shaping the structure, processes, and operations of the VIEWS organization. These ensure transparency and consistency across projects.
- Contribution Guides: Step-by-step instructions for contributing to VIEWS repositories, including pull request guidelines, review processes, and coding standards.
- Onboarding Resources: Essential tools and instructions to help new team members get started quickly and efficiently.
- Templates: Ready-to-use templates for pull requests, issue creation, and decision records to standardize collaboration across teams.
- Best Practices: In-depth documentation for workflows, version control, CI/CD processes, and other operational guidelines to ensure smooth and efficient collaboration.
- FAQs and Glossary: Answers to common questions and a glossary of terms to help new and experienced members alike navigate VIEWS terminology.
If you are interested in in-depth documentation of each of the views-platform repositories, along with their components, please see the individual repository-specific README files:
- Pipeline execution: views-pipeline-core
- About the VIEWS models: views-models
- About VIEWS stepshifter: views-stephifter
- About VIEWS HydraNet: views-hydranet
- Forecast evaluation: views-evaluation
This repository is regularly updated to reflect evolving organizational needs and best practices. Contributions and feedback are welcome!
Special thanks to the VIEWS MD&D Team for their collaboration and support.