Rafael/bump v3.1.0rc1

[rafaelpadilla]

Overview

This PR improves documentation quality, dependency management, and GitHub Actions efficiency for the 3W Toolkit.

Key points:

• Added lychee checks for broken URLs in HTML and Markdown files
• Added contributing instructions for environment setup and quality checks
• Explicitly updated tornado to >=6.5.5,<7

This PR makes the project easier to maintain, improves documentation reliability, and keeps CI faster and cleaner.

---

Summary of Changes

1. Added Broken-Link Checking

• Added lychee validation to detect broken URLs in documentation files
• Checks cover both HTML and Markdown files
• Helps maintain higher documentation quality and prevents stale or invalid links from being merged

---

2. Updated Contributing Documentation

• Updated 3W_TOOLKIT_CONTRIBUTING.md with a new contributing note
• Added guidance for setting up the development environment
• Included instructions for running quality checks locally, including:
  • pytest
  • linting

These updates make the contribution process clearer and easier for new contributors to follow.

---

3. Updated Dependency Version

• Explicitly bumped the tornado dependency to >=6.5.5,<7
• Keeps the dependency version controlled and compatible with the current project requirements

---

4. Improved CI Workflow Structure

• Split linting and tests into separate GitHub Actions jobs
• Linting now runs only once
• Tests run across multiple Python versions
• This makes the workflow faster, cleaner, and easier to understand

---

By creating this pull request, I confirm that I have read and fully accept and agree with one of the Petrobras' Contributor License Agreements (CLAs):

• ICLA: Individual Contributor License Agreement on behalf of only yourself;
• CCLA: Corporate Contributor License Agreement on behalf of your employer.

Our CLAs are based on the Apache Software Foundation's CLAs:

• ICLA: Individual Contributor License Agreement
• CCLA: Corporate Contributor License Agreement

[ricardoevvargas]

Hi, @rafaelpadilla.

I hope this PR will result in another significant contribution from the Federal University of Rio de Janeiro to the 3W Project.

We will evaluate it ASAP and will let you know here if we have any questions and/or requests for adjustments.

On behalf of the 3W Community, I thank you for this PR.