Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 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. 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
```
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

- **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!
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ 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)
To contact the committee, you can use the email address: [infrastructure@numfocus.org](infrastructure@numfocus.org)

## License

Expand Down