Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
118 lines (80 loc) · 4 KB

CONTRIBUTING.md

File metadata and controls

118 lines (80 loc) · 4 KB
Raw

Contributing to Angular Material 16 Dynamic Custom Theme

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Development Setup

  1. Clone the repository

    git clone https://github.com/yourusername/angular-material-16-dynamic-theme.git
cd angular-material-16-dynamic-theme

  2. Install dependencies

    npm install

  3. Start the development server

    npm start

  4. Open your browser and navigate to http://localhost:4200/

Code Style

  • Use TypeScript for all new code
  • Follow Angular style guide conventions
  • Use meaningful variable and function names
  • Add JSDoc comments for public methods and complex logic
  • Ensure proper indentation (2 spaces)
  • Use SCSS for styling with proper nesting

Testing

  • Write unit tests for new features
  • Ensure all existing tests pass
  • Test your changes in both light and dark themes
  • Test responsive behavior on different screen sizes

Feature Requests

We welcome feature requests! Please:

  1. Check if the feature already exists or is planned
  2. Open an issue with the "enhancement" label
  3. Provide a clear description of the feature
  4. Explain why this feature would be useful
  5. Include mockups or examples if applicable

Code of Conduct

Our Pledge

We pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Enforcement

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct.

License

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

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft