Style

[burhanuddin6]

Change pylintrc file to ignore style issues from the following:

1. django modules
2. migrations folder

Use pylint suggestions to improve styles. Do not change the naming conventions as for now

[Kamaruddheen]

Please provide the steps for running pylint in the Readme file. It would help me a lot to understand the project.

[burhanuddin6]

The issue I have with pylint is that I have certain style conventions (specially those in models.py) file that I want to remain as they are in order to differentiate those from python classes. Also shows errors such as not a member object when I used the "." operator on objects that are not defined in the init method. So in order to overlook those errors, I have disabled those check in the "pylintrc" file. Other issue is that I do not want pylint to check some path (the migrations folder), which I have tried to provide under ignore-paths variable in "pylintrc" (but that is not working because I am not good with path and regex patterns).

In the git actions, you will see a pylint workflow. I have provided "pylintrc" as an rcfile in "run" and also pylint_django as a third-party module. pylint_django helps me to overlook some of the things I defined above.

If you want to contribute, you can do this:

1. Disable checking the migrations folder by editing "pylintrc". May be there is another easier way to solve this by editing the workflow?
2. As you can see the pylint workflow fails with 7.28/10 score which can be improved if you just follow the suggestions pylint provides. I am not targeting a 10/10 but 9+ would be reasonable

I hope this gives clarity.

[burhanuddin6]

PS: I am also new to web programming and github actions so thank you for helping me out

[Kamaruddheen]

PS: I am also new to web programming and github actions so thank you for helping me out

I'm happy to help ✨

[Kamaruddheen]

The issue I have with pylint is that I have certain style conventions (specially those in models.py) file that I want to remain as they are in order to differentiate those from python classes. Also shows errors such as not a member object when I used the "." operator on objects that are not defined in the init method. So in order to overlook those errors, I have disabled those check in the "pylintrc" file. Other issue is that I do not want pylint to check some path (the migrations folder), which I have tried to provide under ignore-paths variable in "pylintrc" (but that is not working because I am not good with path and regex patterns).

In the git actions, you will see a pylint workflow. I have provided "pylintrc" as an rcfile in "run" and also pylint_django as a third-party module. pylint_django helps me to overlook some of the things I defined above.

If you want to contribute, you can do this:

1. Disable checking the migrations folder by editing "pylintrc". May be there is another easier way to solve this by editing the workflow?
2. As you can see the pylint workflow fails with 7.28/10 score which can be improved if you just follow the suggestions pylint provides. I am not targeting a 10/10 but 9+ would be reasonable

I hope this gives clarity.

You can assign this issue to me,

1. Firstly, I will start working on excluding migrations folder and increase the pylint score.
2. For Increasing score, I see a lot of files are from views.py, forms.py, etc

[burhanuddin6]

I have made a commit so you can pull or fork again.

[Kamaruddheen]

Now migrations folder will be ignored from this point on. I have manually setup up ignore-paths as ats\\<app-name>\\migrations.

For example,

app-name = applicants or recruiters
ignore-paths = ats\\applicants\\migrations (or) ats\\recruiters\\migrations

I increased pylint score for the following,

1. line-too-long - Line should not contain more than 100 characters
2. import-outside-toplevel - imports should always be in top of file
3. import hierarchy - re-arrange imports based on order
4. Add new lines at end of file
5. Remove unused lines and import

To resolve line-too-long, a line should broken down into multiple lines of code.

In string case, use \ symbols to continue in a new line.

"Lorem Ipsum is simply dummy text of the printing and typesetting industry. \ 
Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, ..."

In functions case, break the paramater/arguments into new lines,

function (
 arg1 = value,
 arg2 = value,
 arg3 = value,
 ...
)