Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (64 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

88 lines (64 loc) · 2.69 KB

Contributing to My Portfolio

Thank you for your interest in my portfolio! While this is primarily a personal portfolio, I welcome feedback, suggestions, and collaborations.

📋 Types of Contributions

Bug Reports

If you find any issues with the portfolio website or SmartWatt project documentation:

  • Use the GitHub Issues tab
  • Provide a clear description of the bug
  • Include steps to reproduce if possible
  • Mention your browser/environment

Feature Suggestions

Have ideas for improvements?

  • Open an issue with the enhancement label
  • Describe the feature and why it would be useful
  • Link any relevant research or references

Feedback & Suggestions

🔄 Pull Requests

While I primarily manage this portfolio myself, I'm open to contributions:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/YourFeature)
  3. Make your changes with clear commit messages
  4. Push to the branch (git push origin feature/YourFeature)
  5. Open a Pull Request with a clear description of changes

PR Guidelines

  • Ensure code follows existing style conventions
  • Update documentation as needed
  • Test your changes locally
  • Provide context for why the change is needed

💡 Areas for Collaboration

I'm particularly interested in:

  • Energy Analytics: Improvements to SmartWatt AI methodology
  • Web Development: UI/UX enhancements to the portfolio
  • Machine Learning: Advanced techniques for energy prediction
  • Documentation: Better case studies and technical explanations
  • Testing: Unit tests and integration tests

📖 Documentation

If improving documentation:

  • Keep formatting consistent
  • Use clear, professional language
  • Include code examples where relevant
  • Update the table of contents if adding sections

🎯 Code Standards

JavaScript/React

  • Use ESLint configuration
  • Follow functional component patterns
  • Use meaningful variable names
  • Add JSDoc comments for complex functions

Python

  • Follow PEP 8 style guide
  • Add docstrings to functions and classes
  • Use type hints where possible
  • Include meaningful variable names

📞 Questions or Concerns?

Feel free to reach out:

⚖️ License

By contributing, you agree that your contributions will be licensed under the MIT License.

🙏 Recognition

Contributors will be acknowledged in the project and I'm happy to provide reference letters or recommendations for collaborative work!

Thank you for your interest in my portfolio and projects!