Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (21 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.68 KB

How to Contribute to FoundationDesign 🎉

Thanks so much for considering contributing to FoundationDesign! Here's how you can get involved:

  • 🔧 Submit Pull Requests
    Contributions that add features, improve tests, or fix bugs are highly welcome. Please ensure your code passes existing tests and adheres to the project's style (Ruff, SciPy/NumPy conventions).

  • 🧩 Pick a Good First Issue
    If you're new, check out the open issues or the "Future Works" section in the README-for example, adding PDF report generation, strip/strap footing design, API support, or expanding foundation types (piles, rafts).

  • 💡 Share Feedback
    This is my first major Python project-your thoughts on usability, documentation, test quality, even coding style are incredibly valuable. Constructive feedback helps the project grow!

  • 🐛 Report Bugs or Suggest Features
    Spot a bug? Have a feature request? Just open an issue on GitHub-it’s the most straightforward way for me to track and respond. If it’s easier for you, feel free to message me at kunleyusuf858@outlook.com.

🛠 Getting Started

  1. Fork the repo and create a feature branch.
  2. Install locally with pip install -e . and run pytest.
  3. Write tests for any new functionality or bug fix.
  4. Open a Pull Request with a clear description of your changes.

🤝 Need Help?

Don't hesitate to contact me if you're unsure where to start or want to discuss your ideas. Happy to guide you through the process!

Your contribution-no matter how small-helps make FoundationDesign better for learners, practitioners, and engineers worldwide. Let's build something great together!