Skip to content

Commit

Permalink
Update contributing guidelines.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Jan 10, 2024
1 parent 0b47b6d commit 0eb773a
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Expand All @@ -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

Expand All @@ -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*!

---

0 comments on commit 0eb773a

Please sign in to comment.