Skip to content

Commit 3722a50

Browse files
Merge pull request #96 from pranavbaburaj/master
Updated the files according to codacy style guides #96
2 parents 642c195 + 950535a commit 3722a50

File tree

4 files changed

+60
-17
lines changed

4 files changed

+60
-17
lines changed

CODE_OF_CONDUCT.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,37 @@ For the betterment of open-source and in order to make a welcoming environment,
88

99
Examples of behavior that contributes to creating a positive environment includes:
1010

11+
12+
1113
- Using welcoming and inclusive language
14+
15+
1216
- Being respectful of differing viewpoints and experiences
17+
18+
1319
- Gracefully accepting constructive criticism
20+
21+
1422
- Focusing on what is best for the community
23+
24+
1525
- Showing empathy towards other community members
1626

1727
Examples of unacceptable behavior by participants includes:
1828

29+
1930
- The use of sexualized language or imagery and unwelcome sexual attention or advances
31+
32+
2033
- Trolling, insulting/derogatory comments, and personal or political attacks
34+
35+
2136
- Public or private harassment
37+
38+
2239
- Publishing others' private information, such as a physical or electronic address, without explicit permission
40+
41+
2342
- Other conduct which could reasonably be considered inappropriate in a professional setting
2443

2544
## Our Responsibilities

CONTRIBUTING.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
1+
12
## 🤝First time contributing? We will help you out.👍
23

34
![GitHub custom open for collaboration](https://img.shields.io/badge/Open%20For-Collaboration-brightgreen?style=for-the-badge)
45

56
Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:
67

78
- [Getting started with Git and GitHub](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github)
9+
10+
811
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
12+
13+
914
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request)
15+
16+
1017
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
1118

1219
***If you don't have git on your machine, [install it](https://help.github.com/articles/set-up-git/).***
@@ -16,19 +23,26 @@ Refer to the following articles on the basics of Git and Github and can also con
1623
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
1724
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/)
1825

26+
27+
1928
- Take a look at the Existing [Issues](https://github.com/IndianOpenSourceFoundation/dynamic-cli.git) or create your own Issues!
29+
2030
- Wait for the Issue to be assigned to you after which you can start working on it.
31+
2132
- Fork the Repo and create a Branch for any Issue that you are working upon.
33+
2234
- Read the [Code of Conduct](https://github.com/IndianOpenSourceFoundation/dynamic-cli.git)
35+
2336
- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
37+
2438
- Add Screenshots to help us know what this Script is all about.
2539

26-
## HOW TO MAKE A PULL REQUEST :
40+
## How to make a pull request
2741

28-
**1.** Fork [this](https://github.com/IndianOpenSourceFoundation/dynamic-cli.git) repository.
42+
**1.** Fork [this](https://github.com/IndianOpenSourceFoundation/dynamic-cli/fork) repository.
2943
Click on the <a href="https://github.com/IndianOpenSourceFoundation/dynamic-cli.git"><img src="https://img.icons8.com/ios/24/000000/code-fork.png"></a> symbol at the top right corner.
3044

31-
**2.** Clone the forked repository. Open terminal and type:
45+
**2.** Clone the forked repository.
3246

3347
```bash
3448
git clone https://github.com/<your-github-username>/project_name.git
@@ -62,29 +76,38 @@ git push
6276

6377
**9.** **Congratulations!** Sit and relax, you've made your contribution to Dynamic-CLI project.
6478

65-
6679
***:trophy: After this, project leaders and mentors will review the changes and will merge your PR if they are found good, otherwise we will suggest the required changes.***
6780

68-
## Style Guides for Git Commit Messages:memo:
81+
## Style guide for git commit messages
82+
83+
*Here's a list of some good to have points, that can add more value to your contribution logs.*
84+
6985

70-
#### Here's a list of some good to have points, that can add more value to your contribution logs.
7186

7287
- Use the present tense (example: "Add feature" and not "Added feature")
88+
7389
- Use the imperative mood (example: "Move item to...", instead of "Moves item to...")
90+
7491
- Limit the first line (also called subject line) to 50 characters or less
92+
7593
- Capitalize the subject line
94+
7695
- Separate subject from body with a blank line
96+
7797
- Do not end the subject line with a period
98+
7899
- Wrap the body at 72 characters
100+
79101
- Use the body to explain what, why, vs, and how
102+
80103
- Reference issues and pull requests liberally after the first line
81104

82-
For more detailed reference to the above points, refer here: https://chris.beams.io/posts/git-commit.
105+
For more detailed reference to the above points, refer [here](https://chris.beams.io/posts/git-commit.)
83106

84-
## 💥 Issues:
107+
## 💥 Issues
85108
For major changes, you are welcomed to open an issue about what you would like to contribute. Enhancements will be appreciated.
86109

87-
#### All the Best!🥇
110+
### All the Best!🥇
88111

89112
<p align = "center">
90113

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,17 @@ Options: <br>
4949
`-GET -> Make a GET request to an API` <br>
5050

5151
## License🗄
52+
The project is licensed under the GNU General Public License v3. Check out [`LICENSE`](https://github.com/IndianOpenSourceFoundation/dynamic-cli/blob/master/LICENSE)
5253

5354
### Contributing
5455

5556
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat&logo=git&logoColor=white)](https://github.com/IndianOpenSourceFoundation/dynamic-cli/pulls) [![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/IndianOpenSourceFoundation/dynamic-cli)
5657

5758
**We're accepting PRs for our open and unassigned [issues](https://github.com/IndianOpenSourceFoundation/dynamic-cli/issues)**. Please check [CONTRIBUTING.md](CONTRIBUTING.md). We'd love your contributions! **Kindly follow the steps below to get started:**
5859

59-
**1.** Fork [this](https://github.com/IndianOpenSourceFoundation/dynamic-cli) repository.
60-
61-
**2.** Clone the forked repository. Open terminal and type:
60+
**1.** Fork [this](https://github.com/IndianOpenSourceFoundation/dynamic-cli/fork) repository.
6261

62+
**2.** Clone the forked repository.
6363
```bash
6464
git clone https://github.com/<your-github-username>/project_name.git
6565
```
@@ -83,10 +83,10 @@ Eg: `\U0001F604`
8383
**5.** Stage your changes and commit
8484

8585
```bash
86-
#Add changes to Index
86+
# Add changes to Index
8787
git add .
8888

89-
#Commit to the local repo
89+
# Commit to the local repo
9090
git commit -m "<your_commit_message>"
9191
```
9292

src/arguments/search.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
#!/usr/bin/env python
2-
import argparse
32
import webbrowser
43
from termcolor import colored
54
import sys as sys
@@ -43,7 +42,7 @@ def search_args(self):
4342
self.playbook_object.display_panel()
4443
elif self.arguments.new:
4544
url = "https://stackoverflow.com/questions/ask"
46-
if type(self.arguments.new) == str:
45+
if isinstance(self.arguments.new, str):
4746
webbrowser.open(f"{url}?title={self.arguments.new}")
4847
else:
4948
webbrowser.open(url)
@@ -93,5 +92,7 @@ def search_for_results(self, save=False):
9392
if save:
9493
filename = SaveSearchResults(data)
9594
print(
95+
colored(f"\U0001F604 Answers successfully saved into {filename}",
96+
"green"))
9697
colored("\U0001F604 Answers successfully saved into" +\
97-
filename, "green"))
98+
filename, "green"))

0 commit comments

Comments
 (0)