Skip to main content

Contributing to ValkyrAI

We welcome contributions from the community! If you're interested in improving ValkyrAI, please follow these steps:

Steps to Contribute​

  1. Fork the Repository: Create a personal fork of the ValkyrAI repository on GitHub.

  2. Create a Feature Branch: Develop your feature or fix in a dedicated branch.

  3. Commit Your Changes: Make clear and descriptive commit messages. For example, use the format: Fix: Corrected the issue with user authentication.

  4. Open a Pull Request: Submit your changes for review, providing detailed information about the changes you've made. Include references to any related issues.

  5. Participate in the Review Process: Engage with maintainers and address any feedback or requested changes promptly.

Code Quality and Testing​

  • Ensure that your code adheres to the project's coding standards and best practices.
  • Write unit tests for any new features or bug fixes to ensure code reliability.
  • Run existing tests to confirm that your changes do not break any existing functionality.

Documentation​

  • Update relevant documentation to reflect your changes, including user guides and API documentation.
  • Ensure that any new features are well-documented with examples.

Code of Conduct​

Please note that all contributors are expected to adhere to our Code of Conduct. We are committed to fostering a welcoming and respectful community.

License​

This project is licensed under the MIT License. By contributing to ValkyrAI, you agree that your contributions will be licensed under the same license.

Next: Disclaimer