Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

69 lines (42 loc) · 2.28 KB

Contributing to the Project

We appreciate your interest in contributing to this project! Below are the detailed guidelines for both organization members and external contributors.

For Organization Members

If you're part of the organization:

  1. You can commit directly to the repository for simple development tasks, such as fixing typos, small bug fixes, or documentation updates.

  2. For more significant contributions:

    • Follow branch naming conventions: feature/<description> or fix/<description>.
    • Test your changes locally.
    • Submit a merge request (MR) for review.

For further details, please continue reading this file.

For External Contributors

If you're an external contributor, follow these steps to contribute:

  1. Fork the Repository:

    • Start by forking this repository and cloning it to your local machine.
    git clone <your-fork-link>

  2. Create a New Branch:

    • Create a branch for your changes:
    git checkout -b feature/<short-description>

  3. Follow Coding Standards:

    • Adhere to the project's coding standards. Check any existing guidelines in the repository.

  4. Testing:

    • Test your changes thoroughly using the provided test cases or scripts.

  5. Submit a Pull Request (PR):

    • Push your changes to your fork and open a pull request to the main repository.
    • Clearly describe:
      • What changes you made.
      • Why they are necessary.
      • Any issues resolved or enhancements added.

  6. Engage in the Review:

    • Be prepared to discuss and make updates based on feedback from the maintainers.

Ethical Rules

All contributors, whether internal or external, are expected to adhere to the following ethical guidelines:

  1. Respect: Maintain a respectful and constructive attitude when collaborating with others.
  2. Original Work: Ensure that all contributions are your own work or appropriately attributed to their original sources.
  3. No Harmful Code: Do not introduce malicious, unethical, or harmful code into the repository.
  4. Compliance: Follow all applicable laws and regulations when contributing to this project.