Skip to content

Commit

Permalink
feat(): add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ArmanTaheriGhaleTaki committed Apr 11, 2024
1 parent 9d3f41b commit c8ab6b8
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
you can add new DNS servers in [.env](https://github.com/ArmanTaheriGhaleTaki/speed-test-dns/blob/main/.env) with the following format
```
#########################
#https://example.com/
#xxx.xxx.xxx.xxx yyy.yyy.yyy.yyy
```
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
18 changes: 0 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,6 @@ or you can use built image uploaded in dockerhub
```sh
wget -c https://raw.githubusercontent.com/ArmanTaheriGhaleTaki/speed-test-dns/main/.env && docker run --env-file .env armantaherighaletaki/speed-test-dns
```
## Contributing

you can add new DNS servers in [.env](https://github.com/ArmanTaheriGhaleTaki/speed-test-dns/blob/main/.env) with the following format
```
#########################
#https://example.com/
#xxx.xxx.xxx.xxx yyy.yyy.yyy.yyy
```
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request



<!-- CONTACT -->
## Contact
Expand Down

0 comments on commit c8ab6b8

Please sign in to comment.