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

docs(reade.md): Align setup and usage instruction to work on Windows #37

Merged
merged 2 commits into from
Feb 5, 2021

Conversation

pajhiwo
Copy link
Collaborator

@pajhiwo pajhiwo commented Feb 4, 2021

chore: add step with local virtual env creation and flatten last comand and in 6 so it is easy to copy on windows

@pajhiwo pajhiwo requested a review from czerus February 4, 2021 19:58
@pajhiwo pajhiwo added the documentation Improvements or additions to documentation label Feb 4, 2021
@czerus
Copy link
Owner

czerus commented Feb 4, 2021

Keep the commit subject (first line) close to 70 chars. current is too long. Also I am using in scope (currently) file (in this case README.md) or dir with changes e.g. pydriver

chore: add step with local virtual env creation and flatten last command in 6 so it is easy to copy on windows

so in this case I would change it to:

README.md: Align setup and usage instruction to work on Windows.

@czerus
Copy link
Owner

czerus commented Feb 4, 2021

I believe that also place where then environment var is set needs to be updated to work on windows

Copy link
Owner

@czerus czerus left a comment

Choose a reason for hiding this comment

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

Please change commit message and update setting env variables on windows

@czerus
Copy link
Owner

czerus commented Feb 4, 2021

lets move to type/scope proposed here https://www.conventionalcommits.org/en/v1.0.0/ and here: https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines so

build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
docs: Documentation only changes
feat: A new feature
fix: A bug fix
perf: A code change that improves performance
refactor: A code change that neither fixes a bug nor adds a feature
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test: Adding missing tests or correcting existing tests

So for this commit lets use type docs

README.md Outdated Show resolved Hide resolved
@pajhiwo pajhiwo changed the title reade.md small change docs(reade.md): Align setup and usage instruction to work on Windows Feb 5, 2021
@pajhiwo pajhiwo requested a review from czerus February 5, 2021 12:46
@czerus czerus merged commit dd76811 into master Feb 5, 2021
@czerus czerus deleted the small_description_fix branch February 5, 2021 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants