Skip to content

Enhancements for Developer Contribution Experience #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

thatvideoshopguy
Copy link

Overview

This pull request introduces a series of updates to improve the developer experience and streamline the contribution workflow for the Spreadsheet Forms project.

Changes Included

  • Markdown Linting: The CHANGELOG has been linted to adhere to proper markdown syntax, ensuring readability and consistency.
  • Gitignore Update: Incorporated the official Python .gitignore from GitHub to keep our repository clean from common unnecessary file tracking.
  • Missing Matrix: Modified lint.yml to include a matrix strategy for multiple Python versions, ensuring our codebase integrity across environments.
  • LibreOffice Docker Integration: I added a Linuxserver.io Docker image for LibreOffice, allowing developers without access to Excel to view pytest output spreadsheets.
  • Sphinx-autobuild: Integrated sphinx-autobuild into our development dependencies for real-time feedback when editing documentation.
  • README Refinement: Refined the README.md to provide more straightforward setup instructions.

Testing and Verification

  • Verify the CHANGELOG format for consistency.
  • Pull the branch and check that the .gitignore behaves as expected.
  • Run the GitHub Actions workflow to ensure the Python version matrix functions correctly.
  • Utilise the LibreOffice Docker container to open and inspect spreadsheet outputs.
  • Test the sphinx-autobuild for live documentation updates.
  • Follow the updated README.md to set up a fresh development environment.

@thatvideoshopguy thatvideoshopguy marked this pull request as draft November 11, 2023 23:35
@thatvideoshopguy thatvideoshopguy marked this pull request as ready for review November 11, 2023 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant