Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 3.49 KB

Contributing to sumologic-python-sdk

Workflow for contributing

  1. Create a branch directly in this repo or a fork (if you don't have push access). Please name branches within this repository <fix type>/<description>. For example, something like feature/install_from_deb.

  2. Create an issue or open a PR. If you aren't sure your PR will solve the issue, or may be controversial, we commend opening an issue separately and linking to it in your PR, so that if the PR is not accepted, the issue will remain and be tracked.

  3. Close (and reference) issues by the closes #XXX or fixes #XXX notation in the commit message. Please use a descriptive, useful commit message that could be used to understand why a particular change was made.

  4. Keep pushing commits to the initial branch, --amend-ing if necessary. Please don't mix fixing unrelated issues in a single branch.

  5. Create a changelog entry as per Keep A Changelog. You should only be putting new stuff under ## [Unreleased] and should not concern yourself with bumping the version and dates as this will be done when releasing changes. When you need to have a change that will break things it needs to be called out with a ### Breaking Changes as opposed to a more common header such as ### Added, ### Fixed, ### Changed. This helps maintainers evaluate what the appropriate version bump should be as there could be changes that are not immediately released.

  6. When everything is ready for merge, clean up the branch (rebase with master to synchronize, squash, edit commits, etc) to prepare for it to be merged. Unless you have meaningful history it should be a single commit. Prefer a rebase to a merge for brining in changes that have been committed to upstream master.

Merging contributions

  1. After reviewing commits for documentation, passing CI tests, and good descriptive commit messages, merge it with either "squash and merge" or "rebase and merge" do not use the "merge pull request" as it does not do a fast forward first.

Upgrading to new python versions

  1. Update python version in Pipfile.
  2. Run pipenv update --python <new version ex 3.12> will update the Pipfile.lock file.
  3. Run pyupgrade sumologic/sumologic.py will upgrade the syntax.
  4. Run pipenv run bandit sumologic/sumologic.py will find common security issues.
  5. Run pipenv run flake8 sumologic/sumologic.py will find linting issues.

Building and Releasing

  1. Create/update the changelog entries and evaluate the type of release.

  2. Run pip install pipenv to install pipenv

  3. Run pipenv install --dev to install dev dependencies

  4. Run pipenv run python -m build

  5. Run pipenv run python -m twine upload dist/* to publish in pypi repository

  6. The new wheel package gets released automatically after the tags are pushed using Github actions(Refer tagged-release in https://github.com/marvinpinto/action-automatic-releases). Run below commands to create and push tags

    git tag -a v<major.minor.patch> <commit_id>

    git push origin v<major.minor.patch>

Testing

  1. Generate the access keys by following the sumologic docs. The user should have Manage Collectors permissions.
  2. export the below environment variables export SUMOLOGIC_ACCESS_ID=<your user's access id> export SUMOLOGIC_ACCESS_KEY = <your user's access key>
  3. Run the unit tests present in test folder python -m unittest