Skip to content

Added Contribution guidelines and links on how to build the site locally #8

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

Merged
merged 1 commit into from
Oct 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# How to contribute

This site is for the community, by the community. I'm very happy that you want to make the Test
automation journey easier for the next engineer. 🤝

## To contribute

All the pages are written in markdown and to contribute you would need familiarity with markdown
syntax. Refer to [this](https://guides.github.com/features/mastering-markdown/) guide from Github

The site is currently divided into two sections

### Community

Lists resources around Testing and automation communities, newsletters, thought leaders to follow
and amazing podcasts, If you would like to add to it, please raise a PR with the changes and the
project maintainer will review and get back

### Tech

Lists useful resources around learning different pillars of Test automation such as Web, Mobile,
Backend automation. Please add relevant links and follow the same workflow

## FAQ

### How do I raise a PR?

Please refer to this guide on
[Github](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,21 @@ reference to that.

The site is hosted on
[automationhacks.io/how-to-learn-test-automation/](https://automationhacks.io/how-to-learn-test-automation/)

## How to contribute

Refer to [CONTRIBUTING.md](CONTRIBUTING.md)

## Build locally

If you want to build the site locally, clone this repo and then execute below commands

> Note: You might want to use
> [pipenv to setup python dependencies](https://automationhacks.io/2020/07/12/how-to-manage-your-python-virtualenvs-with-pipenv/)

```zsh
# activate pipenv
pipenv install
# View from local
mkdocs serve
```
File renamed without changes.