Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.55 KB
Raw

Contributing to Peri

Thank you for your interest in contributing to Peri! We welcome contributions from everyone. Please take a moment to review this guide.

How to Contribute

Reporting Bugs

If you find a bug, please report it by creating a new issue with the following details:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected and actual behavior.
  • Screenshots, if applicable.
  • Your environment details (Elixir version, Peri version).

Feature Requests

If you have an idea for a new feature, please create a feature request issue:

  • A clear and descriptive title.
  • A detailed description of the feature and its purpose.
  • Any relevant examples or use cases.

Submitting Pull Requests

To submit a pull request:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Ensure all tests pass.
  5. Commit your changes with a descriptive message.
  6. Push your branch to your forked repository.
  7. Create a pull request with a clear title and description.

Code Style

Please follow the existing coding style and conventions. This helps maintain code readability and consistency.

Running Tests

Make sure to run all tests before submitting a pull request. You can run tests using:

mix test

Documentation

Update the documentation for any changes or new features. This helps users understand how to use the library.

Contact

If you have any questions or need further assistance, feel free to create an issue or contact the maintainers.

Thank you for your contributions!