-
Notifications
You must be signed in to change notification settings - Fork 182
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: #35 Update tokenization logic causing issues for larger codebases (
#68) * fix: Update tokenization logic causing API errors #35 * chore: Update project documentation. * chore: Update project documentation.
- Loading branch information
Showing
34 changed files
with
10,632 additions
and
10,203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ categories: | |
| labels: | ||
| - chore | ||
| - maintenance | ||
| - refactor | ||
| - title: ⛔️ Deprecated | ||
| labels: | ||
| - deprecated | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,57 @@ | ||
| # Contributing Guidelines | ||
| Welcome to our open source project! We appreciate your interest in contributing to our project. Please take a moment to review these guidelines before making a contribution to ensure a smooth and successful collaboration. | ||
|
|
||
| ## Ways to Contribute | ||
| There are many ways to contribute to our project. You can: | ||
| Thanks for your interest in contributing to *README-AI*! Please review these guidelines to ensure a smooth process. | ||
|
|
||
| - Report issues and bugs | ||
| - Suggest new features or improvements | ||
| - Submit bug fixes or code contributions | ||
| ## Make Valuable Contributions | ||
|
|
||
| ## Code of Conduct | ||
| We expect all contributors to adhere to our code of conduct to ensure a respectful and inclusive environment for everyone. Our code of conduct can be found in the [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md) file. | ||
| Strive to make **useful**, **creative**, and **high quality** contributions. | ||
|
|
||
| ## How to Contribute | ||
| **Useful:** Solve common problems, use cases, exceptions, or issues. | ||
|
|
||
| Contributions are always welcome! Please follow these steps: | ||
| **Creative:** Innovative and helping us all learn new things. | ||
|
|
||
| 1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project. | ||
| 2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop. | ||
| 3. Create a new branch with a descriptive name (e.g., `new-feature-branch` or `bugfix-issue-123`). | ||
| ```sh | ||
| git checkout -b new-feature-branch/add-some-feature | ||
| ``` | ||
| 4. Make changes to the project's codebase. | ||
| 5. Commit your changes to your local branch with a clear commit message that explains the changes you've made. | ||
| ```sh | ||
| git commit -m 'Implemented new feature.' | ||
| ``` | ||
| 6. Push your changes to your forked repository on GitHub using the following command | ||
| ```sh | ||
| git push origin new-feature-branch/add-some-feature | ||
| ``` | ||
| 7. Create a [pull request](https://github.com/eli64s/README-AI/pulls) to the original repository. | ||
| **High Quality:** Well-written, structured, and explained. | ||
|
|
||
| Open a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. | ||
| The project maintainers will review your changes and provide feedback or merge them into the main branch. | ||
| ## Follow The Code of Conduct | ||
|
|
||
| ## Reporting Issues and Bugs | ||
| Review and adhere to our [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md). | ||
|
|
||
| If you find an issue or bug in our project, please report it by opening a new issue in the project's issue tracker. Please include a clear description of the issue or bug, as well as any relevant code or error messages. | ||
| ## Ways to Contribute | ||
|
|
||
| ## Suggesting New Features or Improvements | ||
| There are many ways to contribute to *README-AI*! You can: | ||
|
|
||
| If you have an idea for a new feature or improvement to our project, please suggest it by opening a new issue in the project's issue tracker. Please include a clear description of the feature or improvement you are suggesting, as well as any relevant examples or use cases. | ||
| - 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. | ||
| - Find unhandled exceptions and bugs when running the program. | ||
| - Write unit test for the program. | ||
| - 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? | ||
|
|
||
| ## Submitting Bug Fixes or Code Contributions | ||
| These are just a few exmaples, there are many more ways to contribute to *README-AI*. | ||
|
|
||
| If you would like to contribute code to our project, please follow these guidelines: | ||
| ## Submitting Changes | ||
|
|
||
| - Before making a contribution, please discuss your proposed changes with the project maintainers to ensure they align with the project's goals and direction. | ||
| - Please write clear, well-documented code that adheres to the project's coding style and standards. | ||
| - Please write unit tests for any new code contributions or changes to ensure they are working correctly and do not break existing functionality. | ||
| - Please ensure your code is properly formatted and free of any linting errors or warnings. | ||
| - Please commit your changes with clear and descriptive messages that explain what you have done. | ||
| - Please ensure your changes are rebased onto the latest version of the main project branch before submitting a pull request. | ||
| - Please ensure your pull request includes a clear description of the changes you have made and why they are necessary or beneficial. | ||
| 1. Fork the repository and clone it locally. | ||
| 2. Create a new branch with a descriptive name i.e <code>feature/new-feature-name</code> or <code>bugfix-issue-123</code>. | ||
| 3. Make focused changes with clear commits. | ||
| 4. Open a pull request document the changes you've made and why they're necessary. | ||
| 5. Respond to code reviews from maintainers. | ||
|
|
||
| ## Code Reviews | ||
| ## Code Quality Expectations | ||
|
|
||
| All contributions to our project will be reviewed by project maintainers before they are merged into the main project branch. Reviews may include feedback on the code, suggestions for improvement, or requests for additional testing or documentation. | ||
| - Clear, well-documented code | ||
| - Include tests for new code | ||
| - Follow project style standards | ||
| - Rebase onto latest main branch | ||
|
|
||
| ## Attribution | ||
|
|
||
| Contributors to our project will be acknowledged in the project's README.md file and AUTHORS.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.md file. | ||
| 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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.