From c9c2b03042206f38b10380f1b940d9e2048e3bbb Mon Sep 17 00:00:00 2001 From: Aditya30ag Date: Thu, 5 Feb 2026 18:10:19 +0530 Subject: [PATCH 1/3] docs: add CONTRIBUTING.md and update README contributing reference --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 51 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..146d416 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing to NumFOCUS Infrastructure Committee + +We welcome contributions to the NumFOCUS Infrastructure Committee documentation! Here's how you can help: + +## Getting Started + +1. Fork this repository +2. Create a feature branch (`git checkout -b feature/amazing-feature`) +3. Make your changes +4. Build the documentation locally to verify changes: + ```bash + pip install -r requirements.txt + cd docs + make html + ``` +5. Commit your changes (`git commit -m 'Add amazing feature'`) +6. Push to the branch (`git push origin feature/amazing-feature`) +7. Open a Pull Request + +## Types of Contributions + +- **Documentation improvements**: Fix typos, clarify explanations, update outdated information +- **New content**: Add new sections covering infrastructure topics, case studies, or best practices +- **Process updates**: Improve the review process documentation or CI/CD guides +- **Project information**: Update project listings and vendor information + +## Guidelines + +- Follow the existing documentation style and formatting +- Ensure all links are working and relevant +- Test your changes by building the documentation locally +- Keep changes focused and atomic +- Write clear commit messages describing your changes + +## Review Process + +All contributions go through our standard review process: +1. Automated checks (if any) +2. Committee member review +3. Feedback and iteration +4. Merge approval + +## Getting Help + +For questions about contributing, please contact us at infrastructure@numfocus.org. + +Thank you for contributing to the NumFOCUS Infrastructure Committee! diff --git a/README.md b/README.md index f4c61fa..aabb321 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,10 @@ pip install tox tox -e build_docs ``` +## Contributing + +Please see our [Contributing Guidelines](CONTRIBUTING.md) for information on how to contribute to this project. + ## Contact [To contact the committee, you can use the email address: infrastructure@numfocus.org](infrastructure@numfocus.org) From eb8e536cb13c590a3ccbe2067bc8b48bd9ab9c0a Mon Sep 17 00:00:00 2001 From: Aditya30ag Date: Thu, 5 Feb 2026 18:19:42 +0530 Subject: [PATCH 2/3] fix the build --- CONTRIBUTING.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 146d416..ff065a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,15 +7,19 @@ We welcome contributions to the NumFOCUS Infrastructure Committee documentation! 1. Fork this repository 2. Create a feature branch (`git checkout -b feature/amazing-feature`) 3. Make your changes -4. Build the documentation locally to verify changes: +4. Run code formatting and checks: + ```bash + pre-commit run --all-files + ``` +5. Build the documentation locally to verify changes: ```bash pip install -r requirements.txt cd docs make html ``` -5. Commit your changes (`git commit -m 'Add amazing feature'`) -6. Push to the branch (`git push origin feature/amazing-feature`) -7. Open a Pull Request +6. Commit your changes (`git commit -m 'Add amazing feature'`) +7. Push to the branch (`git push origin feature/amazing-feature`) +8. Open a Pull Request ## Types of Contributions @@ -35,6 +39,7 @@ We welcome contributions to the NumFOCUS Infrastructure Committee documentation! ## Review Process All contributions go through our standard review process: + 1. Automated checks (if any) 2. Committee member review 3. Feedback and iteration From f355d8750636e5368d9580b0a619f47d111b80c4 Mon Sep 17 00:00:00 2001 From: Aditya30ag Date: Fri, 6 Feb 2026 11:30:57 +0530 Subject: [PATCH 3/3] correct the contact section in the readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aabb321..50a3dfa 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Please see our [Contributing Guidelines](CONTRIBUTING.md) for information on how ## Contact -[To contact the committee, you can use the email address: infrastructure@numfocus.org](infrastructure@numfocus.org) +To contact the committee, you can use the email address: [infrastructure@numfocus.org](infrastructure@numfocus.org) ## License