diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08959b7c..4e6cafc6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing Guidelines -Thanks for your interest in contributing to *README-AI*! Please review these guidelines to ensure a smooth process. +Thanks for your interest in contributing to *readme-ai*! Please review these guidelines to ensure a smooth process. ## Make Valuable Contributions @@ -18,8 +18,6 @@ Review and adhere to our [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md). ## Ways to Contribute -There are many ways to contribute to *README-AI*! You can: - - Simply start a discussion by asking a question or making a suggestion. - Look for opportunities to make processes more efficient to improve the user experience. - Find ways to make code more readable and easier to understand. @@ -28,8 +26,12 @@ There are many ways to contribute to *README-AI*! You can: - Brainstorm new CLI options and features that would be useful to users. - i.e. `--language` option to specify the language of the README. - What is the best way to implement README file generation in any language selected? +- Work on improving the [readme-ai.streamlit](https://readme-ai.streamlit.app/) web app. + - Improve the UI/UX of the web app. + - Catch any bugs or errors when using the web app. + - Any new features that would be useful to users. -These are just a few exmaples, there are many more ways to contribute to *README-AI*. +These are just a few examples, there are many more ways yu can contribute to *readme-ai*! ## Submitting Changes @@ -48,10 +50,12 @@ These are just a few exmaples, there are many more ways to contribute to *README ## Attribution -Contributors to our project will be acknowledged in the project's README.md file and AUTHORS.md file. +Contributors to our project will be acknowledged in the project's README.md file. ## License By contributing to our project, you agree to license your contributions under the project's open source license. The project's license can be found in the [LICENSE](./LICENSE.md) file. -Thank you for contributing to our project! +Thank you for your interest in contributing to *readme-ai*! + +---