Skip to main content

Contributing

We welcome and appreciate contributions from everyone, regardless of their background, level of experience, or identity. We believe that diversity and inclusion are essential to build a successful and vibrant community.

Getting Started

Code contributions

  1. Fork the repository.
  2. Create a branch for your feature or bug fix.
  3. Make your changes and commit them with descriptive commit messages.
  4. Push your changes to your fork.
  5. Submit a pull request to the main repository with a clear title and a description.

Other ways to contribute

Not a coder? No problem! We appreciate all kinds of contributions, including:

  • Suggesting improvements to the project
  • Enhancing the documentation
  • Fixing typos or other issues
  • Providing feedback on existing features

Code Style

We follow the Angular Style Guide. Please ensure your code follows this style guide and the overall and that your code builds and passes tests before submitting a pull request.

Tests

Please include tests for any new features or bug fixes. All tests should pass before submitting a pull request.

Issues and Pull Requests

Please open an issue for any major changes or additions to the codebase. This allows us to discuss the changes and ensure they are in line with the project's goals.

When submitting a pull request, please reference any related issues and include a clear description of the changes.

We've provided templates for both issues and Pull Requests. Please use them as a guide when creating new issues or pull requests.

License

By contributing to this project, you agree to license your contribution under the MIT License.