You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Thanks for your interest in contributing to pySBD 🎉. The project is maintaine
6
6
1.[Issues and bug reports](#issues-and-bug-reports)</br>
7
7
a. [Submitting issues](#submitting-issues)</br>
8
8
b. [Issue labels](#issue-labels)
9
-
2.[Contributing to the code base](#contribute-to-the-code-base)</br>
9
+
2.[Contributing to the code base](#contributing-to-the-code-base)</br>
10
10
a. [Getting started](#getting-started)</br>
11
11
b. [Add a new rule to existing *Golden Rules Set* (GRS)](#add-a-new-rule-to-existing-golden-rules-set-grs)</br>
12
12
c. [Add new language support](#add-new-language-support)</br>
@@ -26,7 +26,7 @@ When opening an issue, use an **appropriate and descriptive title** and include
26
26
**environment** (operating system, Python version, pySBD version). Choose the report type [from here](https://github.com/nipunsadvilkar/pySBD/issues/new/choose), if type is not available then open a [blank issue](https://github.com/nipunsadvilkar/pySBD/issues/new). The
27
27
[issue template](https://github.com/nipunsadvilkar/pySBD/issues/new?assignees=&labels=&template=bug_report.md&title=%3CAppropriate+title%3E) helps you
28
28
remember the most important details to include. If you've discovered a bug, you
29
-
can also submit a [regression test](#fixing-bugs) straight away. When you're
29
+
can also submit a [regression test](#fix-bugs) straight away. When you're
30
30
opening an issue to report the bug, simply refer to your pull request in the
31
31
issue body. A few more tips:
32
32
@@ -50,23 +50,23 @@ issue body. A few more tips:
50
50
[See this page](https://github.com/nipunsadvilkar/pySBD/labels) for an overview of
51
51
the system author uses to tag our issues and pull requests.
52
52
53
-
## Contribute to the code base
53
+
## Contributing to the code base
54
54
55
55
Happy to see you contibute to pySBD codebase. To help you get started and understand internals of pySBD, a good place to start is to refer to the implementation section of pySBD research paper (link to be added soon). Another great place for reference is to look at [merged pull requests](https://github.com/nipunsadvilkar/pySBD/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Amerged). Depending on the type of your contribution, refer to the assigned labels.
56
56
57
57
### Getting started
58
-
To make changes to pySBD's code base, you need to fork then clone the GitHub repository to your local machine. You'll need to make sure that you have a development environment consisting of a Python distribution including python 3+, pipenv and git installed.
58
+
To make changes to pySBD's code base, you need to fork then clone the GitHub repository to your local machine. You'll need to make sure that you have a development environment consisting of a Python distribution including python 3+, pip and git installed.
59
59
60
60
```python
61
61
python -m pip install -U pip
62
62
git clone https://github.com/nipunsadvilkar/pySBD
63
63
cd pySBD
64
-
pipenv install --dev
64
+
pip install -r requirements-dev.txt
65
65
```
66
-
Since pySBD is lightweight, it requires only python inbuilt modules, more specifically python `re` module to function. Development packages requiremment will be provided by `Pipfile``[dev-packages]`. If you want to use pySBD as a spacy component then install spacy in your environment.
66
+
Since pySBD is lightweight, it requires only python inbuilt modules, more specifically python `re` module to function. Development packages requiremment will be provided in `requirements-dev.txt`. If you want to use pySBD as a spacy component then install spacy in your environment.
67
67
68
68
### Add a new rule to existing *Golden Rules Set* (GRS)
69
-
The language specific *Golden Rules Set* are hand-constructed rules, designed to cover sentence boundaries across a variety of domains. The set is by no means complete and will evolve and expand over time. If you would like to report an issue in existing rule or report a new rule, please [open an issue.](#submitting-issues) If you want to contribute yourself then please go ahead and send pull request by referring to [adding tests](#adding-tests) section.
69
+
The language specific *Golden Rules Set* are hand-constructed rules, designed to cover sentence boundaries across a variety of domains. The set is by no means complete and will evolve and expand over time. If you would like to report an issue in existing rule or report a new rule, please [open an issue.](#submitting-issues) If you want to contribute yourself then please go ahead and send pull request by referring to [add tests](#add-tests) section.
70
70
71
71
### Add new language support
72
72
Great to see you adding new language support to pySBD ✨.</br>
@@ -89,7 +89,7 @@ Your language module & language GRS should be in place by now. Next step is to m
89
89
Author emphasizes on Test-Driven Development [(TDD)](https://testdriven.io/test-driven-development/) approach to ensure robustness of the pySBD module. You will follow a "<spanstyle="color: red;">Red</span>-<spanstyle="color: green;">Green</span>-<spanstyle="color: orange;">Refactor</span>" cycle.
90
90
91
91
1. Make sure you have proper development environment [setup](#getting-started)
92
-
2. Depending on your type of contribution your test script would vary between [feature-specific](#add-new-language-support) / [bugfixspecific](#fix-bugs).
92
+
2. Depending on your type of contribution your test script would vary between [feature-specific](#add-new-language-support) / [bugfix-specific](#fix-bugs).
93
93
3. (<spanstyle="color: red;">Red</span>) Once you add those tests, run `pytest` to make sure it fails deliberately.
94
94
4. (<spanstyle="color: green;">Green</span>) Write just enough code to implement your logic in respective python script to pass the specific test which you added and got failed earlier.
95
95
5. Once it passes, run all the tests to see if your added code doesn't break existing code.
0 commit comments