ycm-core / YouCompleteMe

A code-completion engine for Vim
http://ycm-core.github.io/YouCompleteMe/
GNU General Public License v3.0
25.36k stars 2.8k forks source link

Fix punctuation and clarity in README and LICENSE #4235

Closed iandrade00 closed 1 month ago

iandrade00 commented 1 month ago

Issue Prelude

Please complete these steps and check these boxes (by putting an x inside the brackets) before filing your issue:

Thank you for adhering to this process! It ensures your issue is resolved quickly and that neither your nor our time is needlessly wasted.

Issue Details

Provide a clear description of the problem, including the following key questions:

Fix punctuation and clarity in README and LICENSE

README
-Add a comma in "cost-effective charity, Against Malaria Foundation" for clarity.
-Change "It works on Windows, Mac, and Linux!" to improve sentence flow.

 LICENSE
 - Add clarification and punctuation in the license section: "While the license is permissive, I ask that you do not distribute free copies of this software unless you have significantly changed it."

Include steps to reproduce here.

  1. Open README
  2. Open LICENSE

Include description of a minimal test case, including any actual code required to reproduce the issue.

If you made changes to vimrc_ycm_minimal, pase them here:

<contents of ycm_vimrc_minimal>

Include description of the expected behaviour. Punctuation and clarity in README and LICENSE is slightly off.

  • What actually happened?

Include description of the observed behaviour, including actual output, screenshots, etc.

Diagnostic data

Output of vim --version

Paste output here

Output of YcmDebugInfo

Paste output here

Output of YcmDiags

Paste output here

Output of git rev-parse HEAD in YouCompleteMe installation directory

paste output here

Contents of YCM, ycmd and completion engine logfiles

Reproduce the issue with vim -Nu /path/to/YCM/vimrc_ycm_minimal, which enabled debug logging and other useful diagnostics. Include a link to a gist containing all of the log files listed by :YcmToggleLogs.

OS version, distribution, etc.

Include system information here.

Output of build/install commands

Include link to a gist containing the invocation and entire output of install.py if reporting an installation issue.