Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
The best way to send feedback is to file an issue at https://github.com/pybliometrics-dev/pybliometrics/issues.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Respect the Python Code of Conduct
Before are reporting a bug, please
Upgrade to the newest version if necessary: pip install pybliometrics –upgrade
Make sure your error message is not one of these.
Report bugs at https://github.com/pybliometrics-dev/pybliometrics/issues. Please include:
Your operating system name and version (after import pybliometrics in Python, type print(pybliometrics.__version__).
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to fix it.
Look through the GitHub issues for features. Anything tagged with “enhancement” is open to whoever wants to implement it.
This repo could always use more documentation, whether as part of the official pybliometrics docs, in docstrings, or even on the web in blog posts, articles, and such.
Ready to contribute? Here’s how to set up pybliometrics for local development.
Fork the pybliometrics repo on GitHub.
Clone your fork locally:
$ git clone firstname.lastname@example.org:your_name_here/pybliometrics.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv pybliometrics $ cd pybliometrics/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
Adhere to PEP8
Run nosetests locally python -m nose –verbose (on Windows) or nosetests3 pybliometrics/scopus/tests/ –verbose.
The pull request should work for Python 3.X.