Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[COPY] - Language improvements in Contributing.md #318

Open
acpoppe opened this issue Dec 1, 2024 · 1 comment
Open

[COPY] - Language improvements in Contributing.md #318

acpoppe opened this issue Dec 1, 2024 · 1 comment
Assignees
Labels
backlog Implementation/fix not planned yet documentation Improvements or additions to documentation
Milestone

Comments

@acpoppe
Copy link

acpoppe commented Dec 1, 2024

Report

CONTRIBUTING.md

This following sentences don't seem right:

Please note we have a code of conduct, please follow it in all your interactions with the project.

and I think it should be changed to:

Please note we have a code of conduct. Please follow it in all your interactions with the project.


This following sentences don't seem right:

I my previous job I used SFTP/SCP pratically everyday and that made me to desire an application like termscp so much, that eventually I started to work on it in the spare time.

and I think it should be changed to:

At my previous job, I used SFTP/SCP practically everyday and that made me desire an application like termscp so much that eventually I started to work on it in my spare time.


This following sentences don't seem right:

I saw there was a very cool library to create terminal user interface (tui-rs), so I started to code it.

and I think it should be changed to:

I saw there was a very cool library to create terminal user interfaces (tui-rs), so I started to code it.


This following sentences don't seem right:

I wrote termscp as an experiment, I designed kinda nothing at the time.

and I think it should be changed to:

I wrote termscp as an experiment. I didn't design anything at the time.


This following sentences don't seem right:

I just said

and I think it should be changed to:

I just said,


This following sentences don't seem right:

Ok, there must be a FileTransfer trait somehow, I'll have more views, so I'll use something like Android activities, and there must be a module to interact with the local host".

and I think it should be changed to:

"Ok, there must be a FileTransfer trait somehow. I'll have more views, so I'll use something like Android activities, and there must be a module to interact with the local host."


The rest of the file goes on much like this. There's nothing exceptionally bad, but there are some easy to correct mistakes and it often doesn't read like native English. I'd be happy to open a PR with corrections like these, if you'd like. I haven't read through any of the other English documentation with this on my mind, but perhaps it exists in other documents as well.

Additional information

❗ Report LANGUAGE checks only if it concerns the documents above
❗ If the documents concerns more than one language, copy paste the checks below for each check you want to report
❗ The PR mention regards the indicated language. If you check the box, I may add you to a PR where I need to translate a new section of the user manual/README or other documents. I promise I won't stress you anyway.

  • [ x] I am C1/C2 speaker for this language: ENGLISH (Native Speaker)
    • [ x] You can mention me in a PR in case a review for translations is needed
@acpoppe acpoppe added the documentation Improvements or additions to documentation label Dec 1, 2024
@acpoppe acpoppe changed the title [COPY] - English as a second language in Contributing.md [COPY] - Language improvements in Contributing.md Dec 2, 2024
@veeso
Copy link
Owner

veeso commented Dec 28, 2024

If you can please open a PR, otherwise I will just copy the changes

@veeso veeso added the backlog Implementation/fix not planned yet label Dec 28, 2024
@veeso veeso added this to the 0.17.0 milestone Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Implementation/fix not planned yet documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants