Skip to content

docs: add CONTRIBUTING.md#577

Merged
lukehinds merged 4 commits intoalways-further:mainfrom
ognis1205:docs/add-contributing-md
Jan 12, 2026
Merged

docs: add CONTRIBUTING.md#577
lukehinds merged 4 commits intoalways-further:mainfrom
ognis1205:docs/add-contributing-md

Conversation

@ognis1205
Copy link
Copy Markdown
Contributor

@ognis1205 ognis1205 commented Jan 10, 2026

Summary

Add a CONTRIBUTING.md file to the repository. This file provides guidelines for setting up the development environment, running tests, linting and formatting code, committing changes, and contributing to the documentation.

Details

  • Includes instructions for creating and activating a virtual environment (Option A: standard Python, Option B: using uv)
  • Explains how to install development dependencies and documentation dependencies
  • Provides steps to run unit tests, integration tests, and security checks
  • Includes linting and formatting instructions using ruff
  • Covers documentation workflow: writing docs, docstring conventions, serving and building docs locally

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
@ognis1205 ognis1205 marked this pull request as ready for review January 10, 2026 18:52
@ognis1205
Copy link
Copy Markdown
Contributor Author

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a comprehensive CONTRIBUTING.md file, which is a great addition to the project. The guide is well-structured and covers all essential aspects of the development workflow, from setting up the environment to running tests and contributing to documentation. I've provided a few minor suggestions to improve clarity and user experience for new contributors. Overall, this is an excellent contribution.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
@lukehinds lukehinds merged commit 9eae20e into always-further:main Jan 12, 2026
6 checks passed
@ognis1205 ognis1205 deleted the docs/add-contributing-md branch January 13, 2026 06:07
@ognis1205
Copy link
Copy Markdown
Contributor Author

Thanks!

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.

2 participants