diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f2b82f7d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributions are welcome! Please read the following guidelines before contributing. + +## How to contribute + +1. Fork the project +2. Create a new branch +3. Commit your changes +4. Ensure features are tested and documented +5. Create a new Pull Request + +## How to update the documentation + +1. Head to the [Documentation Repo](https://github.com/Assistants-Center/Soft-UI-Docs) +2. Fork the project +3. Create a new branch +4. Preview docs with `yarn docs:dev` +5. Make changes to the docs +6. Commit your changes +7. Create a new Pull Request + +## Submitting a bug report + +1. Join the [Discord Server](https://discord.gg/CHbfcSbEgd) +2. Create a new post in the #report-bug channel +3. Describe the bug +4. Provide a codepen and steps to reproduce the bug +5. Provide screenshots if possible and any console errors + +## Submitting a feature request + +1. Join the [Discord Server](https://discord.gg/CHbfcSbEgd) +2. Create a new post in the #suggestions channel +3. Describe the feature +4. Provide screenshots if possible + +### Thank you for your contributions! +#### Assistants Center \ No newline at end of file