-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,197 +1,24 @@ | ||
| .. highlight:: shell | ||
|
|
||
| ============ | ||
| Contributing | ||
| ============ | ||
|
|
||
| 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 | ||
| ---------------------- | ||
|
|
||
| Report Bugs | ||
| ~~~~~~~~~~~ | ||
|
|
||
| Report bugs at https://github.com//sdv-dev/SDGym/issues. | ||
|
|
||
| If you are reporting a bug, please include: | ||
|
|
||
| * Your operating system name and version. | ||
| * Any details about your local setup that might be helpful in troubleshooting. | ||
| * Detailed steps to reproduce the bug. | ||
|
|
||
| Fix Bugs | ||
| ~~~~~~~~ | ||
|
|
||
| Look through the GitHub issues for bugs. Anything tagged with "bug" and "help | ||
| wanted" is open to whoever wants to implement it. | ||
|
|
||
| Implement Features | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Look through the GitHub issues for features. Anything tagged with "enhancement" | ||
| and "help wanted" is open to whoever wants to implement it. | ||
|
|
||
| Write Documentation | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| SDGym could always use more documentation, whether as part of the | ||
| official SDGym docs, in docstrings, or even on the web in blog posts, | ||
| articles, and such. | ||
|
|
||
| Submit Feedback | ||
| ~~~~~~~~~~~~~~~ | ||
|
|
||
| The best way to send feedback is to file an issue at https://github.com/sdv-dev/SDGym/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. | ||
| * Remember that this is a volunteer-driven project, and that contributions | ||
| are welcome :) | ||
|
|
||
| Get Started! | ||
| ------------ | ||
|
|
||
| Ready to contribute? Here's how to set up `SDGym` for local development. | ||
|
|
||
| 1. Fork the `SDGym` repo on GitHub. | ||
| 2. Clone your fork locally:: | ||
|
|
||
| $ git clone git@github.com:your_name_here/SDGym.git | ||
|
|
||
| 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, | ||
| this is how you set up your fork for local development:: | ||
|
|
||
| $ mkvirtualenv SDGym | ||
| $ cd SDGym/ | ||
| $ make install-develop | ||
|
|
||
| 4. Create a branch for local development:: | ||
|
|
||
| $ git checkout -b name-of-your-bugfix-or-feature | ||
|
|
||
| Now you can make your changes locally. | ||
|
|
||
| 5. While hacking your changes, make sure to cover all your developments with the required | ||
| unit tests, and that none of the old tests fail as a consequence of your changes. | ||
| For this, make sure to run the tests suite and check the code coverage:: | ||
|
|
||
| $ make test # Run the tests | ||
| $ make coverage # Get the coverage report | ||
|
|
||
| 6. When you're done making changes, check that your changes pass flake8 and the | ||
| tests, including testing other Python versions with tox:: | ||
|
|
||
| $ make lint # Check code styling | ||
| $ make test-all # Execute tests on all python versions | ||
|
|
||
| 7. Make also sure to include the necessary documentation in the code as docstrings following | ||
| the `google docstring`_ style. | ||
| If you want to view how your documentation will look like when it is published, you can | ||
| generate and view the docs with this command:: | ||
|
|
||
| $ make viewdocs | ||
|
|
||
| 8. 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 | ||
|
|
||
| 9. Submit a pull request through the GitHub website. | ||
|
|
||
| .. _google docstring: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html | ||
|
|
||
| Pull Request Guidelines | ||
| ----------------------- | ||
|
|
||
| Before you submit a pull request, check that it meets these guidelines: | ||
|
|
||
| 1. It resolves an open GitHub Issue and contains its reference in the title or | ||
| the comment. If there is no associated issue, feel free to create one. | ||
| 2. Whenever possible, it resolves only **one** issue. If your PR resolves more than | ||
| one issue, try to split it in more than one pull request. | ||
| 3. The pull request should include unit tests that cover all the changed code | ||
| 4. If the pull request adds functionality, the docs should be updated. Put | ||
| your new functionality into a function with a docstring, and add the | ||
| feature to the list in README.rst. | ||
| 5. The pull request should work for Python 3.8, 3.9, 3.10, 3.11 and 3.12. Check | ||
| https://github.com/sdv-dev/SDGym/actions | ||
| and make sure that all the checks pass. | ||
|
|
||
| Unit Testing Guidelines | ||
| ----------------------- | ||
|
|
||
| All the Unit Tests should comply with the following requirements: | ||
|
|
||
| 1. Unit Tests should be based only in unittest and pytest modules. | ||
|
|
||
| 2. The tests that cover a module called ``sdgym/path/to/a_module.py`` should be | ||
| implemented in a separated module called ``tests/sdgym/path/to/test_a_module.py``. | ||
| Note that the module name has the ``test_`` prefix and is located in a path similar | ||
| to the one of the tested module, just inside te ``tests`` folder. | ||
|
|
||
| 3. Each method of the tested module should have at least one associated test method, and | ||
| each test method should cover only **one** use case or scenario. | ||
|
|
||
| 4. Test case methods should start with the ``test_`` prefix and have descriptive names | ||
| that indicate which scenario they cover. | ||
| Names such as ``test_some_methed_input_none``, ``test_some_method_value_error`` or | ||
| ``test_some_method_timeout`` are right, but names like ``test_some_method_1``, | ||
| ``some_method`` or ``test_error`` are not. | ||
|
|
||
| 5. Each test should validate only what the code of the method being tested does, and not | ||
| cover the behavior of any third party package or tool being used, which is assumed to | ||
| work properly as far as it is being passed the right values. | ||
|
|
||
| 6. Any third party tool that may have any kind of random behavior, such as some Machine | ||
| Learning models, databases or Web APIs, will be mocked using the ``mock`` library, and | ||
| the only thing that will be tested is that our code passes the right values to them. | ||
|
|
||
| 7. Unit tests should not use anything from outside the test and the code being tested. This | ||
| includes not reading or writting to any filesystem or database, which will be properly | ||
| mocked. | ||
|
|
||
| Tips | ||
| ---- | ||
|
|
||
| To run a subset of tests:: | ||
|
|
||
| $ pytest tests.test_sdgym | ||
|
|
||
| Release Workflow | ||
| ---------------- | ||
|
|
||
| The process of releasing a new version involves several steps combining both ``git`` and | ||
| ``bumpversion`` which, briefly: | ||
|
|
||
| 1. Merge what is in ``main`` branch into ``stable`` branch. | ||
| 2. Update the version in ``setup.cfg``, ``sdgym/__init__.py`` and ``HISTORY.md`` files. | ||
| 3. Create a new git tag pointing at the corresponding commit in ``stable`` branch. | ||
| 4. Merge the new commit from ``stable`` into ``main``. | ||
| 5. Update the version in ``setup.cfg`` and ``sdgym/__init__.py`` | ||
| to open the next development iteration. | ||
|
|
||
| .. note:: Before starting the process, make sure that ``HISTORY.md`` has been updated with a new | ||
| entry that explains the changes that will be included in the new version. | ||
| Normally this is just a list of the Pull Requests that have been merged to main | ||
| since the last release. | ||
|
|
||
| Once this is done, run of the following commands: | ||
|
|
||
| 1. If you are releasing a patch version:: | ||
|
|
||
| make release | ||
| We love our community’s interest in the SDV ecosystem. The SDV software | ||
| (and its related libraries) is owned and maintained by DataCebo, Inc. | ||
| It is available under the `Business Source License`_ for you to browse. | ||
|
|
||
| 2. If you are releasing a minor version:: | ||
| We support a large set of users with enterprise-specific intricacies and | ||
| reliability needs. This has required us to be deliberate about setting | ||
| the roadmap for SDV libraries. As a result, we are unable to prioritize | ||
| reviewing and accepting external pull requests. As a policy, we will | ||
| not be able to accept external contributions. | ||
|
|
||
| make release-minor | ||
| **Would you like a bug or feature request to be addressed?** If you haven't | ||
| already, we would greatly appreciate it if you could `file an issue`_ | ||
| instead with the overall description of your problem. We can determine | ||
| whether it’s aligned with our framework. Once discussed, our team | ||
| typically resolves smaller issues within a few release cycles. | ||
| We appreciate your understanding. | ||
|
|
||
| 3. If you are releasing a major version:: | ||
|
|
||
| make release-major | ||
| .. _Business Source License: https://github.com/sdv-dev/SDGym/blob/main/LICENSE | ||
| .. _file an issue: https://github.com/sdv-dev/SDGym/issues |