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

Update CONTRIBUTING.md #2384

Merged
merged 3 commits into from Apr 25, 2023
Merged

Update CONTRIBUTING.md #2384

merged 3 commits into from Apr 25, 2023

Conversation

ElminD
Copy link
Contributor

@ElminD ElminD commented Apr 18, 2023

I used Grammarly and other tools to update the file

docs: Updated grammar Contributing
Signed-off-by: Elmin Didic [edidic@iastate.edu]

Signed-off-by: Elmin Didic <35606145+ElminD@users.noreply.github.com>
Copy link
Contributor

@thecodrr thecodrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate you taking the time to pass this through Grammarly & friends. There are some mistakes, however, probably due to this being Markdown which Grammarly doesn't work well with.

CONTRIBUTING.md Outdated
@@ -81,15 +81,15 @@ The DCO is a declaration attached to every contribution made by every developer

**Each commit must include a DCO which looks like this:**

```txt
"`txt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are creating a codeblock here. The requested change here is incorrect.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

CONTRIBUTING.md Outdated
Signed-off-by: Jane Smith <jane.smith@email.com>
```

On VSCode, it looks like this:

![](resources/vscode-signed-off-commit.png)

You may type this line on your own when writing your commit messages. However, if your [user.name](http://user.name) and [user.email](http://user.email) are set in your git configs, you can use `-s` or `--signoff` to add the `Signed-off-by` line to the end of the commit message automatically.
You may type this line on your own when writing your commit messages. However, if your [user.name](http://user.name) and [user.email](http://user.email) are set in your git configs, you can use `-s' or `--signoff` to add the `Signed-off-by` line to the end of the commit message automatically.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The requested change here is incorrect.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

CONTRIBUTING.md Outdated
@@ -119,7 +119,7 @@ All commits must include valid scopes in the commit message. **Valid commit scop

**Some example commits would look like this:**

```txt
"`txt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The requested change here is incorrect.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Signed-off-by: Elmin Didic <35606145+ElminD@users.noreply.github.com>
@ElminD
Copy link
Contributor Author

ElminD commented Apr 20, 2023

Should be all fixed

@ElminD ElminD requested a review from thecodrr April 20, 2023 16:19
Copy link
Contributor Author

@ElminD ElminD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated all changes

CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Abdullah Atta <thecodrr@protonmail.com>
@thecodrr thecodrr merged commit 909bdfa into streetwriters:master Apr 25, 2023
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants