Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 5.06 KB

CONTRIBUTING.md

File metadata and controls

84 lines (60 loc) · 5.06 KB

Contributing to PHYLOViZ Web Platform

Thank you for your interest in contributing to the PHYLOViZ Web Platform! We welcome contributions from the community to help improve and enhance the platform's functionality. This guide will provide you with an overview of the contribution process.

Table of Contents

  1. Contributing Guidelines
  2. Getting Started
  3. Submitting a Contribution
  4. Code Review Process
  5. Community Guidelines
  6. Contact Information

Contributing Guidelines

Before you start contributing to the PHYLOViZ Web Platform, please take a moment to review the following guidelines:

  1. Familiarize yourself with the project by exploring the documentation, codebase, and existing issues.
  2. If you plan to work on a new feature or significant changes, it's recommended to discuss it with the project maintainers beforehand to ensure it aligns with the project's goals and roadmap.
  3. Make sure to follow the coding style and conventions used in the project. Adhering to consistent code formatting will make the review process smoother.
  4. Test your changes thoroughly to ensure they don't introduce any regressions or issues.
  5. Document your code updates and any new features or changes you introduce.
  6. Respect the existing contributors and maintain a positive and inclusive attitude towards other community members.

Getting Started

To contribute to the PHYLOViZ Web Platform, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Install the necessary dependencies as outlined in the project's documentation.
  4. Create a new branch for your contribution, using a descriptive and meaningful name.
  5. Make your desired changes or additions to the codebase.
  6. Test your changes locally to ensure they work as intended.
  7. Commit your changes and provide a clear and concise commit message.
  8. Push your branch to your forked repository on GitHub.

Submitting a Contribution

Once you have made your changes and pushed them to your forked repository, you can submit your contribution by following these steps:

  1. Navigate to the original repository on GitHub.
  2. Locate the "Pull Requests" tab.
  3. Click on "New Pull Request" to create a new pull request.
  4. Select the appropriate branches for the base and compare repositories.
  5. Provide a descriptive title and detailed description for your pull request.
  6. Include any relevant information or context that may help with the review process.
  7. Submit the pull request, and it will be reviewed by the project maintainers.

Code Review Process

After submitting a pull request, the project maintainers will review your code and provide feedback. Here's what you can expect during the review process:

  1. The maintainers will review your code for adherence to coding standards, functionality, and any potential issues.
  2. They may request changes or improvements to your code. Please address these requests promptly and make the necessary updates.
  3. Once your code meets the project's requirements and standards, it will be approved and merged into the main repository.
  4. If there are any conflicts or issues during the review process, maintain an open and collaborative mindset to resolve them.

Community Guidelines

To ensure a positive and inclusive community environment, we kindly request that you adhere to the following guidelines:

  1. Treat all community members with respect and courtesy. Avoid any form of harassment, discrimination, or offensive behavior.
  2. Be considerate of others' opinions and perspectives, even if they differ from your own.
  3. Provide constructive feedback and suggestions to help improve the project.
  4. Help others in the community by sharing your knowledge and expertise.
  5. Avoid spamming, advertising, or promoting unrelated content within the community channels.
  6. If you encounter any issues or have concerns about the project or community, reach out to the project maintainers privately.

Contact Information

If you have any questions, concerns, or need assistance, you can reach out to the authors of the PHYLOViZ Web Platform through the following emails:

Please feel free to contact any of the authors if you have any inquiries related to the PHYLOViZ Web Platform. They will be happy to assist you.

If you encounter any bugs, have feature requests, or would like to report any issues, please visit the Issues section on GitHub and create a new issue. Your feedback and contributions are valuable to us, and we appreciate your help in improving the platform.

We appreciate your interest and contribution to the PHYLOViZ Web Platform. Thank you for helping us improve the platform and make it even better for the community!