@@ -134,25 +134,34 @@ To set up ScanCode for local development:
134134
135135 Run this command to configure ScanCode::
136136
137- ./configure
137+ ./configure --dev
138138
139139 On Windows use instead::
140140
141- configure
141+ configure --dev
142142
143- Then run this: `source bin/activate ` or `. bin/activate `
144- (or run `bin\\activate ` on Windows)
143+ Then activate the virtual environment::
144+
145+ source bin/activate
146+
147+ or
148+
149+ . bin/activate
150+
151+ On Windows use::
152+
153+ Scripts\activate
145154
146155 When you create a new terminal/shell to work on ScanCode rerun the activate step.
147156
148157 When you pull new code from git, rerun ./configure
149-
158+
150159
1511605. Now you can make your code changes in your local clone.
152161 Please create new unit tests for your code. We love tests!
153162
1541636. When you are done with your changes, run all the tests.
155- Use this command::
164+ Use this command::
156165
157166 py.test
158167
@@ -162,25 +171,25 @@ To set up ScanCode for local development:
162171
163172 If you are running this on a RedHat based OS you may come across this
164173 failure::
165-
174+
166175 OSError: libbz2.so.1.0: cannot open shared object file: No such file or directory
167-
176+
168177 Try creating a symbolic link to libbz2.so.1.0 to solve this issue::
169178
170179 locate libbz2.so.1.0
171180 cd <resulting libbz2.so directory>
172181 sudo ln -s <your version of libbz2.so> libbz2.so.1.0
173-
182+
174183 See `this issue <https://github.com/nexB/scancode-toolkit/issues/443 >`_ for more information.
175184
1761857. Check the status of your local repository before commit, regarding files changed::
177-
186+
178187 git status
179188
180189
1811908. Commit your changes and push your branch to your GitHub fork::
182191
183- git add <file-changed-1> <file-changed-2> <file-changed-3>
192+ git add <file-changed-1> <file-changed-2> <file-changed-3>
184193 git commit -m "Your detailed description of your changes." --signoff
185194 git push <repository-alias-name> name-of-your-bugfix-or-feature
186195
@@ -196,7 +205,7 @@ create a pull request. You can add new commits to your branch as needed.
196205For merging, your request would need to:
197206
1982071. Include unit tests that are passing (run ``py.test ``).
199- 2. Update documentation as needed for new API, functionality etc.
208+ 2. Update documentation as needed for new API, functionality etc.
2002093. Add a note to ``CHANGELOG.rst `` about the changes.
2012104. Add your name to ``AUTHORS.rst ``.
202211
0 commit comments