Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

60 lines (36 loc) · 2.84 KB
Raw

How to Contribute to python-rest-tester

We're excited that you're interested in contributing to python-rest-tester! 👍 Your help is greatly appreciated.

To ensure a smooth contribution process, please follow the guidelines below.

Reporting Issues and Bugs

Found a bug? Here’s how you can help:

  1. Search for Existing Issues: Before opening a new issue, please check the issue tracker to see if the problem has already been reported. If it has, you can contribute additional information for the issue.

  2. Create a Minimal Reproduction: To help us understand and fix the issue, please provide a minimal reproduction scenario. This can be a repository or a code snippet a Gist. Include:

    • Version of python-rest-tester
    • Detailed steps to reproduce the issue

  3. Submit a New Issue: If no existing issue matches your problem, open a new issue using this form.

Requesting Features

Do you have a feature in mind that would make Python REST Tester better? Here’s how to proceed:

  1. Check for Existing Requests: Look through the issue tracker to see if the feature has already been requested. If it has, feel free to add your thoughts and vote for it.

  2. Submit a New Feature Request: If the feature is not yet requested, open a new issue with a detailed description of the feature, including:

    • What the feature does
    • Why it would be useful
    • Any implementation ideas you might have

Submitting Your Contributions

Ready to contribute code? Follow these steps to ensure your contribution is properly reviewed and integrated:

  1. Fork the Repository: Create a fork of the python-rest-tester repo on GitHub.

  2. Create a New Branch: Use a descriptive name for your branch (e.g., new-feature).

  3. Make Your Changes: Implement your feature or fix. Be sure to include appropriate comments, test cases if needed.

  4. Commit Your Changes: Write a descriptive commit message.

    git commit -am "Add new feature to python-rest-tester"

  5. Push Your Branch: Push your branch to your fork on GitHub.

    git push origin new-feature

  6. Open a Pull Request: Go to your forked repository and create a pull request. Provide a clear description of your changes.

  7. Address Feedback: If maintainers request changes, make the updates in your branch and push them.

Thank you for contributing to python-rest-tester framework! Your help is greatly appreciated and helps make this project better for everyone.