Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (41 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

66 lines (41 loc) · 3.34 KB

Contributing to Valdi

Thank you for your interest in Valdi. We welcome community contributions and appreciate your time and effort in helping improve the project. Before getting started, please take a moment to review these guidelines.

1. Code of Conduct

We want this project to be a welcoming space for everyone. By contributing, you agree to follow our Code of Conduct and help keep the community respectful and inclusive.

2. How to Contribute

We welcome contributions in various forms, including:

  • Bug fixes
  • Documentation improvements
  • Tests and performance optimizations

If you would like to add new features, please reach out to the Valdi team on Discord to discuss.

To contribute, follow these steps:

  • Fork the repository and create a new branch.
  • Make your changes, ensuring they align with our coding standards (§4 below).
  • Run tests to ensure your changes do not break existing functionality.
  • Submit a pull request (PR) with a clear description of the changes.
  • A maintainer will review your PR, suggest any necessary changes, and merge it once approved.

Commit Messages

Use clear and descriptive commit messages. Follow the conventional commit format when possible:

feat: Add new authentication method
fix: Resolve issue with session timeout
docs: Update README with new installation steps

3. Legal Terms

By submitting a contribution, you represent and warrant that:

  • It is your original work, or you have sufficient rights to submit it.
  • You grant the Valdi maintainers and users the right to use, modify, and distribute it under the MIT license (see LICENSE file); and
  • To the extent your contribution is covered by patents, you grant a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to the Valdi maintainers and users to make, use, sell, offer for sale, import, and otherwise transfer your contribution as part of the project.

We do not require a Contributor License Agreement (CLA). However, by contributing, you agree to license your submission under terms compatible with the MIT License and to grant the patent rights described above. If your contribution includes third-party code, you are responsible for ensuring it is MIT-compatible and properly attributed.

Where permitted by law, you waive any moral rights in your contribution (e.g., the right to object to modifications). If such rights cannot be waived, you agree not to assert them in a way that interferes with the project’s use of your contribution.

4. Coding Standards

To maintain a consistent codebase, please follow these guidelines:

  • Use the existing coding style and conventions.
  • Ensure all code changes are well-documented.
  • Write tests for new features and bug fixes.
  • Avoid introducing unnecessary dependencies.

5. Reporting Issues

If you find a bug or have a feature request, please open an issue and provide as much detail as possible:

  • Steps to reproduce, including operating system, and Valdi version
  • Expected and actual behavior
  • Suspected cause (if any)

6. Recognition

We use the All Contributors specification to recognize community members. If your contribution is merged, you will be added to the project's list of contributors. This includes contributions of all kinds—code, documentation, design, testing, and more.