@@ -22,15 +22,15 @@ involved. The community looks forward to your contributions.
22
22
> answered your question.
23
23
24
24
Before you ask a question, it is best to search for existing
25
- [ Issues] ( https://github.com/mslmio /oxylabs-sdk-python/issues ) that might help
26
- you. In case you have found a suitable issue and still need clarification, you
27
- can write your question in this issue. It is also advisable to search the
25
+ [ Issues] ( https://github.com/oxylabs /oxylabs-sdk-python/issues ) that might help
26
+ you. In case you have found a suitable issue and still need clarification, you
27
+ can write your question in this issue. It is also advisable to search the
28
28
internet for answers first.
29
29
30
30
If you then still feel the need to ask a question and need clarification, we
31
31
recommend the following:
32
32
33
- - Open an [ Issue] ( https://github.com/mslmio /oxylabs-sdk-python/issues/new ) .
33
+ - Open an [ Issue] ( https://github.com/oxylabs /oxylabs-sdk-python/issues/new ) .
34
34
- Provide as much context as you can about what you're running into.
35
35
- Provide project and platform versions (nodejs, npm, etc), depending on what
36
36
seems relevant.
@@ -47,9 +47,9 @@ We will then take care of the issue as soon as possible.
47
47
48
48
## Code Formatting
49
49
50
- This project uses [ Black] ( https://black.readthedocs.io/en/stable/ ) and
51
- [ isort] ( https://pycqa.github.io/isort/ ) for code formatting. Before you submit
52
- your contribution, please make sure your code is formatted according to these
50
+ This project uses [ Black] ( https://black.readthedocs.io/en/stable/ ) and
51
+ [ isort] ( https://pycqa.github.io/isort/ ) for code formatting. Before you submit
52
+ your contribution, please make sure your code is formatted according to these
53
53
style guides.
54
54
55
55
First, you will need to install the required tools if you haven't already:
@@ -58,8 +58,8 @@ First, you will need to install the required tools if you haven't already:
58
58
pip install black isort
59
59
```
60
60
61
- You can use the provided ` fmt.sh ` script to automatically format your code.
62
- This script runs ` isort ` and ` black ` on the ` src ` directory. Here's how you can
61
+ You can use the provided ` fmt.sh ` script to automatically format your code.
62
+ This script runs ` isort ` and ` black ` on the ` src ` directory. Here's how you can
63
63
run it:
64
64
65
65
``` bash
@@ -68,8 +68,8 @@ scripts/fmt.sh
68
68
69
69
## Running Tests
70
70
71
- To ensure the quality of the code, we encourage you to run tests after making
72
- any changes and before submitting a contribution. We have a script that
71
+ To ensure the quality of the code, we encourage you to run tests after making
72
+ any changes and before submitting a contribution. We have a script that
73
73
facilitates running the unit tests for the project.
74
74
75
75
To run the tests, use the ` tests.sh ` script located in the ` scripts ` directory.
@@ -101,7 +101,7 @@ possible.
101
101
- To see if other users have experienced (and potentially already solved) the
102
102
same issue you are having, check if there is not already a bug report
103
103
existing for your bug or error in the [ bug
104
- tracker] ( https://github.com/mslmio /oxylabs-sdk-python/issues?q=label%3Abug ) .
104
+ tracker] ( https://github.com/oxylabs /oxylabs-sdk-python/issues?q=label%3Abug ) .
105
105
- Also make sure to search the internet (including Stack Overflow) to see if
106
106
users outside of the GitHub community have discussed the issue.
107
107
- Collect information about the bug:
@@ -122,8 +122,8 @@ possible.
122
122
We use GitHub issues to track bugs and errors. If you run into an issue with the
123
123
project:
124
124
125
- - Open an [ Issue] ( https://github.com/mslmio /oxylabs-sdk-python/issues/new ) .
126
- (Since we can't be sure at this point whether it is a bug or not, we ask you
125
+ - Open an [ Issue] ( https://github.com/oxylabs /oxylabs-sdk-python/issues/new ) .
126
+ (Since we can't be sure at this point whether it is a bug or not, we ask you
127
127
not to talk about a bug yet and not to label the issue.)
128
128
- Explain the behavior you would expect and the actual behavior.
129
129
- Please provide as much context as possible and describe the * reproduction
@@ -156,7 +156,7 @@ community to understand your suggestion and find related suggestions.
156
156
- Read the [ documentation] ( https://developers.oxylabs.io/ ) carefully and
157
157
find out if the functionality is already covered, maybe by an individual
158
158
configuration.
159
- - Perform a [ search] ( https://github.com/mslmio /oxylabs-sdk-python/issues ) to see
159
+ - Perform a [ search] ( https://github.com/oxylabs /oxylabs-sdk-python/issues ) to see
160
160
if the enhancement has already been suggested. If it has, add a comment to the
161
161
existing issue instead of opening a new one.
162
162
- Find out whether your idea fits with the scope and aims of the project. It's
@@ -169,7 +169,7 @@ community to understand your suggestion and find related suggestions.
169
169
#### How Do I Submit a Good Enhancement Suggestion?
170
170
171
171
Enhancement suggestions are tracked as
172
- [ GitHub issues] ( https://github.com/mslmio /oxylabs-sdk-python/issues ) .
172
+ [ GitHub issues] ( https://github.com/oxylabs /oxylabs-sdk-python/issues ) .
173
173
174
174
- Use a ** clear and descriptive title** for the issue to identify the
175
175
suggestion.
0 commit comments