Skip to content

Commit eb9c059

Browse files
Gaurav Singhautomationhacks
authored andcommitted
Added Contribution guidelines and links on how to build the site locally to verify
1 parent 5b1a692 commit eb9c059

File tree

3 files changed

+47
-0
lines changed

3 files changed

+47
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# How to contribute
2+
3+
This site is for the community, by the community. I'm very happy that you want to make the Test
4+
automation journey easier for the next engineer. 🤝
5+
6+
## To contribute
7+
8+
All the pages are written in markdown and to contribute you would need familiarity with markdown
9+
syntax. Refer to [this](https://guides.github.com/features/mastering-markdown/) guide from Github
10+
11+
The site is currently divided into two sections
12+
13+
### Community
14+
15+
Lists resources around Testing and automation communities, newsletters, thought leaders to follow
16+
and amazing podcasts, If you would like to add to it, please raise a PR with the changes and the
17+
project maintainer will review and get back
18+
19+
### Tech
20+
21+
Lists useful resources around learning different pillars of Test automation such as Web, Mobile,
22+
Backend automation. Please add relevant links and follow the same workflow
23+
24+
## FAQ
25+
26+
### How do I raise a PR?
27+
28+
Please refer to this guide on
29+
[Github](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,21 @@ reference to that.
1919

2020
The site is hosted on
2121
[automationhacks.io/how-to-learn-test-automation/](https://automationhacks.io/how-to-learn-test-automation/)
22+
23+
## How to contribute
24+
25+
Refer to [CONTRIBUTING.md](CONTRIBUTING.md)
26+
27+
## Build locally
28+
29+
If you want to build the site locally, clone this repo and then execute below commands
30+
31+
> Note: You might want to use
32+
> [pipenv to setup python dependencies](https://automationhacks.io/2020/07/12/how-to-manage-your-python-virtualenvs-with-pipenv/)
33+
34+
```zsh
35+
# activate pipenv
36+
pipenv install
37+
# View from local
38+
mkdocs serve
39+
```
File renamed without changes.

0 commit comments

Comments
 (0)