Merge pull request #76 from nicholasyager/docs/contributing

Add CONTRIBUTING.md file

docs/CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Contributing to dbt-loom
+
+Thank you for taking the time to contribute! 🎉💃
+
+The following is a set of guidelines for contributing to dbt-loom. These are
+mostly guidelines, not rules. Use your best judgment, and feel free to propose
+changes to this document in a pull request.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you find a bug, please report it by opening an issue on GitHub. Make sure to
+include:
+
+- A clear and descriptive title.
+- Steps to reproduce the problem.
+- Expected behavior.
+- Actual behavior.
+- Any relevant logs or screenshots.
+
+### Suggesting Enhancements
+
+If you have an idea to enhance dbt-loom, we'd love to hear about it! Please
+open an issue on GitHub and include:
+
+- A clear and descriptive title.
+- A detailed description of the proposed enhancement.
+- Any relevant use cases or examples.
+
+### Pull Requests
+
+When you're ready to start working on an issue, fork the repository and create
+a new branch for your work. Follow these steps:
+
+1. Fork the repository and clone your fork.
+2. Create a new branch: `git checkout -b feature/my-feature-branch`.
+3. Make your changes and commit them: `git commit -m 'Add some feature'`.
+4. Push to the branch: `git push origin feature/my-feature-branch`.
+5. Open a pull request.
+
+After creating the pull request, the PR will automatically notify the
+maintainers, and they will be able to trigger CI checks for your change.
+
+### Code Style
+
+- Follow the existing code style.
+- Ensure your code passes all tests, including mypy.
+- Write tests for your code if applicable.
+
+### Running Tests
+
+Make sure all tests pass before submitting a pull request. You can run the
+tests with:
+
+```
+pytest tests/
+```
+
+### Documentation
+
+Contributions to documentation are always welcome. If you see something that can be improved or needs clarification, feel free to make changes.
+
+## Code of Conduct
+
+This project adheres to the [Contributor Covenant Code of Conduct](docs/CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code.
+
+## Getting Help
+
+If you need help or have any questions, feel free to open an issue on GitHub.
+
+Thank you for contributing!