Skip to content

Latest commit

 

History

History
127 lines (82 loc) · 4.86 KB

CONTRIBUTING.md

File metadata and controls

127 lines (82 loc) · 4.86 KB

Contributing to Open Text Shield (OTS)

First off, thank you for considering contributing to Open Text Shield! Your support and involvement are invaluable to the success of this project.

The following guidelines will help you contribute effectively and ensure a smooth collaboration with the community.

Table of Contents

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating, you agree to abide by its terms.

Getting Started

  • Fork the Repository: Click the "Fork" button at the top right of the repository page to create a personal copy.

  • Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/your-username/OpenTextShield.git

  • Set Upstream Remote: Add the original repository as a remote to keep your fork up-to-date.

    git remote add upstream https://github.com/OpenTextShield/OpenTextShield.git

  • Install Dependencies: Follow the instructions in the README.md to install any necessary dependencies.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue:

  • Search Existing Issues: Before creating a new issue, please check if it has already been reported.
  • Provide Detailed Information: Include steps to reproduce, expected behavior, actual behavior, and any relevant screenshots or logs.
  • Specify Environment: Mention the version of Open Text Shield, operating system, and any other pertinent details.

Suggesting Enhancements

We welcome suggestions for new features or improvements:

  • Discuss First: It's often helpful to discuss your ideas with the maintainers before investing time in development.
  • Open an Issue: Use the issue tracker to describe your enhancement in detail.
  • Be Clear and Concise: Explain the motivation behind the enhancement and how it benefits users.

Submitting Pull Requests

We appreciate your efforts to improve the codebase:

  • Create a Feature Branch: Work on a new branch specific to your feature or fix.

    git checkout -b feature/your-feature-name

  • Write Clear Commit Messages: Follow the Commit Messages guidelines.

  • Include Tests: Ensure your changes are covered by tests.

  • Update Documentation: Reflect any changes in the documentation.

  • Rebase Before Submitting: Sync your branch with the upstream main branch.

    git fetch upstream
git rebase upstream/main

  • Open a Pull Request: Go to the repository on GitHub and click "New Pull Request".

Coding Standards

Code Style

  • Consistency: Adhere to the existing coding style of the project.
  • Language Conventions: Follow standard conventions for the programming language used.
  • Comments: Write clear and descriptive comments where necessary.
  • Linting: Use linters or formatters as specified in the project's guidelines.

Commit Messages

  • Format: Use the imperative mood ("Add feature" not "Added feature").

  • Structure:

    Short summary (50 characters or less)

More detailed explanatory text, if necessary. Wrap it to about 72 characters or so.

  • Reference Issues: Include issue numbers when applicable (e.g., Fixes #123).

  • Write New Tests: Add tests for new features or bug fixes.

  • Testing Standards: Follow the project's testing framework and conventions.

Documentation

  • Update Documentation: Reflect any code changes in the relevant documentation files.
  • Improve Clarity: Feel free to enhance existing documentation for better clarity or completeness.
  • Consistent Style: Follow the same writing style and formatting as the existing documents.

Community and Support

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for your interest in contributing to Open Text Shield (OTS)! Your involvement helps make this project better for everyone.