Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (73 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

106 lines (73 loc) · 3.65 KB

Contributing to Dynamic Popup

Thank you for your interest in contributing to the Dynamic Popup project! We welcome contributions from the community and are excited to collaborate with you.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct which ensures a welcoming and inclusive environment for all contributors.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on our GitHub issue tracker with the following information:

  1. A clear and descriptive title
  2. A detailed description of the problem
  3. Steps to reproduce the issue
  4. Expected behavior vs. actual behavior
  5. Screenshots or code snippets if applicable
  6. Your environment information (Flutter version, OS, etc.)

Suggesting Enhancements

We welcome feature requests and suggestions! To suggest an enhancement:

  1. Check if there's already an existing issue or pull request
  2. Create a new issue with a clear title and detailed description
  3. Explain why this enhancement would be useful
  4. If possible, provide examples or mockups

Code Contributions

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/dynamic_popup.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes thoroughly
  6. Commit your changes with a clear commit message
  7. Push to your fork
  8. Create a pull request

Pull Request Guidelines

Before submitting a pull request, please ensure:

  1. Your code follows the existing code style
  2. You've added tests for new functionality
  3. All existing tests pass
  4. Documentation is updated if needed
  5. Your commit messages are clear and descriptive
  6. You've rebased your branch on the latest main branch

Code Style

  • Follow the Flutter style guide
  • Use meaningful variable and function names
  • Write clear comments for complex logic
  • Keep functions small and focused
  • Remove any debugging code or console logs

Testing

  • Add unit tests for new functionality
  • Ensure all tests pass before submitting
  • Test your changes on different screen sizes if UI is involved
  • Verify backward compatibility

Development Setup

  1. Clone the repository
  2. Run flutter pub get in the root directory
  3. Run flutter pub get in the example directory
  4. Run tests with flutter test

Documentation

Improvements to documentation are always welcome! This includes:

  • Improvements to README.md
  • Code comments
  • Example code
  • Wiki updates

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you

Community

  • Join our [Discord/Slack channel] (if applicable)
  • Follow us on [Twitter] (if applicable)
  • Check out our [blog] (if applicable)

Questions?

If you have any questions about contributing, feel free to:

  1. Open an issue for discussion
  2. Contact the maintainers directly (if contact info is provided)

Thank you for contributing to Dynamic Popup!