Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (54 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

75 lines (54 loc) · 1.71 KB

Contributing to Femora

Thank you for your interest in contributing to Femora! We welcome contributions from the community.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with:

  • A clear description of the bug
  • Steps to reproduce the issue
  • Expected vs. actual behavior
  • Browser and OS information

Suggesting Features

We'd love to hear your ideas! Open an issue with:

  • A clear description of the feature
  • Why it would be useful
  • Any implementation ideas (optional)

Code Contributions

  1. Fork the repository

  2. Create a feature branch:

    git checkout -b feature/your-feature-name

  3. Make your changes:

    • Follow the existing code style
    • Add comments for complex logic
    • Keep functions focused and modular

  4. Test your changes:

    • Test in multiple browsers
    • Ensure responsive design works
    • Check for console errors

  5. Commit your changes:

    git commit -m "Add: Description of your feature"

  6. Push to your fork:

    git push origin feature/your-feature-name

  7. Open a Pull Request:

    • Provide a clear description
    • Reference any related issues
    • Include screenshots if UI changes

Code Style Guidelines

  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused (single responsibility)
  • Use consistent indentation (2 spaces)
  • Follow existing code patterns

Project Structure

  • index.html - Main HTML structure
  • css/ - Stylesheets
  • js/ - JavaScript modules
  • Each module handles a specific feature

Questions?

Feel free to open an issue for any questions or clarifications.

Thank you for contributing to Femora! 🌸