Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 3.82 KB
Raw

How to contribute to fxpmath

Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new issue. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Before submitting, it is highly recommended:

    • If the bug is not related with an issue, one issue must be opened.
    • If the bug has a linked issue, add a test function in tests/test_issues.py file. The name of the function must be test_issue_{issue number}_{fxpmath version}, for example: test_issue_9_v0_3_6.
    • Update version modifying version at init.py. The new version must be a release candidate, incrementing only PATCH field if there is not a release candidate and add a release candidate field; for example: '0.4.1' to '0.4.2-rc.0'. If actual version is a release candidate, you must increment only the rc field, for example: '0.4.1-rc.3' to '0.4.1-rc.4'.
    • Run all tests and check all of them are succeful.
    • Update changelog.txt at the top, keeping format. Link the solved issue.

Tests are executed using pytest.

New features or changes

  • Suggest your change in the discussions and start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

  • Fork fxpmath repository.

  • Check if a branch for the development of next version exists. If it exists, you should create a new brach from it, keeping the name of the brach as prefix; for example, if the development branch is dev-0.5.0, your new branch should be named dev-0.5.0-{something}. If it doesn't exist, create a branch with the name dev-{new version} incrementing MINOR version field; for example, if actual version is 0.4.1, your new branch should be named dev-0.5.0 or dev-0.5.0-{something}.

  • Build an specific test file to test the new functionality or just update some of the test files with new test functions. All the tests are running executed using pytest.

  • Run all tests and check all of them are succeful.

  • Update version modifying version at init.py.

  • Update changelog.txt at the top, keeping format.

  • Open a new GitHub pull request.

Do you have questions about the source code?

  • Ask any question about how to use fxpmath at discussions.

Do you want to contribute to the fxpmath documentation?

It is very welcome review and update docstrings of classes, properties, methods and functions of fxpmath.

Thanks!