Skip to content

Commit d653259

Browse files
committed
Updated wording for Contributions
1 parent dc031fc commit d653259

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ Contributions of all kinds are welcome. In particular pull requests are apprecia
44

55
## Issues
66

7-
The easiest contribution to make is to [file an issue]().
8-
It is beneficial if you perform a cursory search of [existing issues]() and it is also helpful, but not necessary, if you can provide clear instruction for
9-
how to reproduce a problem. If you have resolved an issue yourself please consider contributing to this repository so others can benefit from your work.
7+
The easiest contribution to make is to [file an issue](https://github.com/TDAmeritrade/stumpy/issues/new). It is beneficial if you perform a cursory search of [existing issues](https://github.com/TDAmeritrade/stumpy/issues?q=is%3Aissue) and it is also helpful, but not necessary, if you can provide clear instruction for how to reproduce a problem. If you have resolved an issue yourself please consider contributing to this repository so others can benefit from your work.
108

119
## Documentation
1210

1311
Contributing to documentation is the easiest way to get started. Providing simple clear or helpful documentation for new users is critical. Anything that *you* as a new user found hard to understand, or difficult to work out, are excellent places to begin. Contributions to more detailed and descriptive error messages is especially appreciated. To contribute to the documentation please
14-
[fork the project]() into your own repository, make changes there, and then submit a pull request.
12+
[fork the project](https://github.com/TDAmeritrade/stumpy/fork) into your own repository, make changes there, and then submit a pull request.
1513

1614
## Code
1715

18-
Code contributions are always welcome, from simple bug fixes, to new features. To contribute code please [fork the project]() into your own repository, make changes there, and then submit a pull request. If you are fixing a known issue please add the issue number to the PR message. If you are fixing a new issue feel free to file an issue and then reference it in the PR. You can [browse open issues](), or consult the [project roadmap](), for potential code contributions. Fixes for issues tagged with 'help wanted' are especially appreciated.
16+
Code contributions are always welcome, from simple bug fixes, to new features. To contribute code please [fork the project](https://github.com/TDAmeritrade/stumpy/fork) into your own repository, make changes there, run [black](https://github.com/python/black) and [flake8](http://flake8.pycqa.org/en/latest/) on your code, add tests for bugs/new features, and then submit a pull request. If you are fixing a known issue please add the issue number to the PR message. If you are fixing a new issue feel free to file an issue and then reference it in the PR. You can [browse open issues](https://github.com/TDAmeritrade/stumpy/issues), or consult the [project roadmap](https://github.com/TDAmeritrade/stumpy/issues/1), for potential code contributions. Fixes for issues tagged with 'help wanted' are especially appreciated.
17+
18+

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ First, please check the issues on github to see if your question has already bee
243243
Contributing
244244
------------
245245

246-
We welcome contributions in any form! Assistance with documentation, particularly expanding tutorials, is always welcome. To contribute please fork the project make your changes and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.
246+
We welcome contributions in any form! Assistance with documentation, particularly expanding tutorials, is always welcome. To contribute please fork the project, make your changes, and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.
247247

248248
----------
249249
References

0 commit comments

Comments
 (0)