Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
126 lines (91 loc) · 5.78 KB

CONTRIBUTING.md

File metadata and controls

126 lines (91 loc) · 5.78 KB

Contributing Guidelines

Thank you for your interest in contributing to robotframework-PlatynUI! Your help is welcome and appreciated. By participating in this project, you agree to abide by this document. Please follow these guidelines to ensure a smooth and efficient process for everyone.

Table of Contents

Getting Started

  1. Fork the Repository: Start by forking the repository on GitHub.
  2. Clone Your Fork:
  3. git clone https://github.com/your-username/robotframework-PlatynUI.git
cd robotframework-PlatynUI
  4. Set Up Your Local Environment: Make sure you have the necessary tools installed and configured as per the repository’s README instructions.
  5. Review the Code: Before you begin working, familiarize yourself with the project’s structure and dependencies.

How to Contribute

There are several ways to contribute to this project:

  • Bug Fixes: If you have found an issue, please check if it already exists in the Issue Tracker. If it does not, open a new issue and provide a detailed description along with steps to reproduce the problem.

  • Feature Requests: If you have an idea for a new feature or an enhancement to an existing feature, please open an issue to discuss your idea. Clearly outline the benefit and implementation suggestions if possible.

  • Pull Requests: You can send pull requests (PRs) for bug fixes, new features, or improvements. Ensure that your PR addresses one issue at a time and includes appropriate tests, documentation, and changes that maintain project quality.

  • Documentation Updates: If you notice areas for improvement in the documentation, feel free to contribute as well.

Reporting Bugs

When filing a bug report, please include as much information as possible:

  • A clear and descriptive title
  • Steps to reproduce the bug: Provide a minimal example if possible.
  • Expected vs. Actual behavior
  • Screenshots or logs: If relevant and available.
  • Environment details: Include the version of Robot Framework, operating system, and any other pertinent details.

Suggesting Enhancements

When suggesting a new feature or improvement:

  • Explain the rationale behind the suggestion.
  • Describe how the change would benefit the project and its users.
  • If possible, include examples or mockups to illustrate your idea.

Pull Request Process

Before you submit a pull request:

  1. Sync with the Latest Code: Make sure your branch is up-to-date with the latest changes from the main branch.
  2. Follow the Coding Guidelines: Ensure that your changes adhere to the existing code style and conventions.
  3. Write Clear Commit Messages: Each commit should have a clear message describing what was changed and why.
  4. Submit Your PR: Provide a detailed description of the changes and reference any issues that are addressed by the PR.
  5. Address Feedback: Be prepared to receive feedback, and work collaboratively to integrate the changes if any modifications are requested.

Coding Standards

To maintain a consistent codebase, please follow these conventions:

  • General Code Style: Use clear, concise, and well-commented code. Follow any specific style guides provided in the repository or community standards.
  • Testing: Write tests for new features and bug fixes to ensure that the project remains robust.
  • Documentation: Update documentation alongside your code changes if necessary, especially if your changes affect usage or functionality.

Commit Messages

When committing changes, please adhere to the following practices:

  • Use the imperative mood (e.g., "Add", "Fix", "Update").
  • Provide a brief summary followed by a more detailed description if necessary.
  • Reference related issues using GitHub keywords (e.g., “Fixes #123”).

Tests and Documentation

  • Automated Tests: Before opening your pull request, run all existing tests and ensure they pass. Include new tests for the new code.
  • Documentation: Update or add documentation as needed. Consistency between code and documentation is key for easy onboarding of new contributors.

Community and Communication

  • Code of Conduct: Please adhere to the Code of Conduct when interacting with the community.
  • Discussion: Use GitHub Issues and PR comments for technical discussions. For broader topics, consider using the project’s mailing list or discussion forum if available.
  • Respect: Always be courteous and respectful when discussing changes and ideas.

License

By contributing, you agree that your contributions will be licensed under the same license as the project. For detailed license information, see the LICENSE file in the repository.

Thank you for contributing to robotframework-PlatynUI! Your support and collaboration are what make this project successful. If you have any questions or need further guidance, please do not hesitate to reach out via the Issue Tracker or your preferred communication channel.