Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.3 KB
Raw

Contributing to Robot-Framework-Mainframe-3270-Library

We welcome contributions to the Robot-Framework-Mainframe-3270-Library! Whether you're fixing a bug, improving existing functionality, or adding new features, your help is greatly appreciated.

Here are some guidelines to help you get started:

Getting Started

  • If a change you'd like to make does not already have an issue, please create one. This helps us discuss the new functionality beforehand.
  • Fork the repository on GitHub.
  • Clone the repository to your local machine.
  • Install the dependencies by running pip install -r requirements-dev.txt from the cloned folder.
  • Create a new branch for your changes.

Making Changes

  • When creating new user keywords, please provide documentation.
  • Write tests for your changes. You may need to include unit tests, acceptance tests, or both, depending on the change you made.
  • Format your code by running inv lint from the cloned folder.
  • Ensure all tests pass by running inv utest for unit tests and inv atest for acceptance tests again from the cloned folder.
  • Push your changes to your fork on GitHub.
  • Create a pull request.

License

By contributing to the Robot-Framework-Mainframe-3270-Library, you agree that your contributions will be licensed under the project's MIT license.