Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (67 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

102 lines (67 loc) · 3.61 KB

Contributing to DLinRT.eu

Welcome!
Thank you for considering contributing to our community-driven resource on Commercial Solutions in Radiotherapy. This project relies on accurate, objective, and up-to-date information.
Please review the following guidelines carefully before submitting your contribution.

Before You Start

Before contributing, please review:

  1. Field Reference Documentation - Essential reading for understanding all data fields, controlled vocabularies, and validation rules
  2. Product Review Guide - Comprehensive guide for adding and reviewing products
  3. Code of Conduct - Our community standards
  4. Security Guidelines - Security best practices

How to Contribute

1. Fork and Clone the Repository

  • Fork the repository to your own GitHub account.
  • Clone your fork to your local machine.
git clone https://github.com/DLinRT-eu/website.git

2. Create a Branch

Create a dedicated branch for your changes.

git checkout -b feature/your-topic

3. Revise and Update Carefully

Before submitting information (new content, edits, corrections), verify the accuracy and relevance by:

  • Cross-checking information with official vendor documentation, scientific publications, or validated technical reports.
  • Citing reliable sources wherever applicable.
  • Maintaining neutrality: do not promote or favor any commercial product over another without evidence.

Every contribution must be carefully reviewed for factual correctness, clarity, and consistency.

4. Writing Standards

  • Use clear, professional language.
  • Be concise but informative.
  • Follow a neutral, evidence-based tone.
  • Use American English spelling.
  • Structure sections clearly (e.g., Overview, Technical Details, Clinical Applications, Limitations).

5. Submit a Pull Request

When your changes are ready:

  • Push your branch to GitHub.
  • Open a pull request (PR) against the main branch.
  • Fill out the provided PR template, explaining what you changed and why.

Pull Request Review Process

Each PR will undergo a review process:

  • Fact-checking: At least two reviewers will verify all technical and commercial details.
  • Clarity and style: Editors will ensure language, structure, and neutrality guidelines are followed.
  • Feedback: You may be asked to make further revisions before merging.

No pull request will be merged without peer review and approval.

Important Notes

  • Conflicts of Interest: If you have any affiliation with a commercial provider, you must disclose it clearly in your PR description.
  • No Promotional Content: Direct marketing language, biased comparisons, and unsupported claims will be rejected.
  • Respect Licenses: Only contribute content you have the right to share (no copyrighted images, proprietary data, etc., without permission).

Code of Conduct

We are committed to fostering a respectful, inclusive community.
By participating, you agree to follow our Code of Conduct.

Questions?

If you are unsure about anything, feel free to open an issue with your question or suggestion.

Let's build a reliable, open knowledge base for the radiotherapy community — together!

Field Reference Documentation: Essential reading for understanding all data fields, controlled vocabularies, and validation rules.

Product Review Guide: Comprehensive guide for adding and reviewing products.

Code of Conduct: Our community standards.

Security Guidelines: Security best practices.