Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leonvanbokhorst authored Dec 14, 2024
1 parent e105e5a commit c0e96ec
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing to Virtual Humans

Thank you for considering contributing to the Virtual Humans project! We welcome contributions from everyone.

## How to Contribute

### Reporting Bugs

If you find a bug, please create an issue on GitHub with the following information:
- A clear and descriptive title
- A detailed description of the issue
- Steps to reproduce the issue
- Any relevant screenshots or logs

### Suggesting Enhancements

If you have an idea for an enhancement or new feature, please create an issue on GitHub with the following information:
- A clear and descriptive title
- A detailed description of the enhancement or feature
- Any relevant use cases or examples

### Submitting Pull Requests

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes in the new branch.
4. Ensure your changes pass all tests and adhere to the project's coding standards.
5. Commit your changes and push the branch to your fork.
6. Create a pull request on GitHub.

### Coding Standards

Please follow these coding standards when contributing to this project:
- Write clear, concise, and well-documented code.
- Follow the Python PEP 8 style guide.
- Write tests for your code and ensure all tests pass.

### Code of Conduct

By contributing to this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

## Getting Help

If you need help with anything related to this project, please feel free to create an issue on GitHub or reach out to the maintainers.

Thank you for your contributions!

0 comments on commit c0e96ec

Please sign in to comment.