diff --git a/.env.example b/.env.example index 91d1e45f2a..75676786db 100644 --- a/.env.example +++ b/.env.example @@ -199,7 +199,7 @@ VITE_APP_TITLE="LibreChat" # Enable Social Login # This enables/disables the Login with Google button on the login page. # Set to true if you have registered the app with google cloud services -# and have set the GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET in the /api/.env file +# and have set the GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET above VITE_SHOW_GOOGLE_LOGIN_OPTION=false # Allow Public Registration diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e28b3e9c08..2feae33e9e 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,4 +1,4 @@ -# Contributor Covenant Code of Conduct +# Contributor Covenant Code of Conduct ## Our Pledge @@ -127,6 +127,6 @@ For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. -## +--- ## [Go Back to ReadMe](README.md) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0993fd02e4..3b55a54f8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,41 +1,34 @@ -# Contributor Guidelines +# Contributor Guidelines -Thank you to all the contributors who have helped make this project possible! We welcome various types of contributions, -such as bug reports, documentation improvements, feature requests, and code contributions. +Thank you to all the contributors who have helped make this project possible! We welcome various types of contributions, such as bug reports, documentation improvements, feature requests, and code contributions. ## Contributing Guidelines -If the feature you would like to contribute has not already received prior approval from the project maintainers (ie. the feature is currently on the roadmap or on the [trello board]()), please submit a proposal in the [proposals category](https://github.com/danny-avila/chatgpt-clone/discussions/categories/proposals) of the discussions board before beginning work on it. -- Proposals should include specific implementation details including areas of the application that will be effected by the change inlcuding designs if applicable, and any other relevant information that might be required for a speedy review. -- Proposals are not required for small changes, bug fixes, or documentation improvements. -- Small changes and bug fixes should be tied to an [issue](https://github.com/danny-avila/chatgpt-clone/issues) and included in the corresponding pull request for tracking purposes. - -*Please note that a pull request involving a feature that has not been reviewed and approved by the project maintainers may be rejected.* +If the feature you would like to contribute has not already received prior approval from the project maintainers (i.e., the feature is currently on the roadmap or on the [Trello board]()), please submit a proposal in the [proposals category](https://github.com/danny-avila/LibreChat/discussions/categories/proposals) of the discussions board before beginning work on it. The proposals should include specific implementation details, including areas of the application that will be affected by the change (including designs if applicable), and any other relevant information that might be required for a speedy review. However, proposals are not required for small changes, bug fixes, or documentation improvements. Small changes and bug fixes should be tied to an [issue](https://github.com/danny-avila/LibreChat/issues) and included in the corresponding pull request for tracking purposes. -If you would like to discuss the changes you wish to make, join our [Discord community](https://discord.gg/uDyZ5Tzhct). +Please note that a pull request involving a feature that has not been reviewed and approved by the project maintainers may be rejected. We appreciate your understanding and cooperation. + +If you would like to discuss the changes you wish to make, join our [Discord community](https://discord.gg/uDyZ5Tzhct), where you can engage with other contributors and seek guidance from the community. ## Our Standards -Please read our [Coding Standards and Conventions](docs/contributions/coding_conventions.md) before beginning on a contribution. +We strive to maintain a positive and inclusive environment within our project community. We expect all contributors to adhere to the following standards: -Examples of behavior that contributes to creating a positive environment -include: +- Using welcoming and inclusive language. +- Being respectful of differing viewpoints and experiences. +- Gracefully accepting constructive criticism. +- Focusing on what is best for the community. +- Showing empathy towards other community members. -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions when necessary. +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that do not align with these standards. ## To contribute to this project, please adhere to the following guidelines: ## 1. Git Workflow -We use a GitFlow workflow to manage changes to this project's codebase. Follow these general steps when contributing code: +We utilize a GitFlow workflow to manage changes to this project's codebase. Follow these general steps when contributing code: -1. Fork the repository and create a new branch with a descriptive slash based name (e.g., new/feature/x). +1. Fork the repository and create a new branch with a descriptive slash-based name (e.g., `new/feature/x`). 2. Implement your changes and ensure that all tests pass. 3. Commit your changes using conventional commit messages with GitFlow flags. Begin the commit message with a tag indicating the change type, such as "feat" (new feature), "fix" (bug fix), "docs" (documentation), or "refactor" (code refactoring), followed by a brief summary of the changes (e.g., `feat: Add new feature X to the project`). 4. Submit a pull request with a clear and concise description of your changes and the reasons behind them. @@ -43,143 +36,65 @@ We use a GitFlow workflow to manage changes to this project's codebase. Follow t ## 2. Commit Message Format -We have very precise rules over how our Git commit messages must be formatted. -This format leads to **easier to read commit history**. +We have defined precise rules for formatting our Git commit messages. This format leads to an easier-to-read commit history. Each commit message consists of a header, a body, and an optional footer. -Each commit message consists of a **header**, a **body**, and a **footer**. +### Commit Message Header - -``` -
- - - -