Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 2.62 KB

contribution_guidelines.md

File metadata and controls

76 lines (59 loc) · 2.62 KB

Thank you for your interest in contributing to Viewer! We welcome contributors of all skill levels to improve this project. Below are detailed steps to help you get started:

  1. Getting Started Fork the Repository

Click on the "Fork" button at the top right of this repository to create your own copy. Clone Your Forked Repository

In your terminal, clone your forked version: bash Copy code git clone https://github.com/your-username/viewer.git Navigate into the project folder: bash Copy code cd viewer Create a New Branch for Your Contribution

Always create a new branch to keep your changes organized: bash Copy code git checkout -b feature/your-feature-name

  1. Making Your Changes Implement Your Changes Whether you're fixing a bug, adding a feature, or improving documentation, make your edits within the new branch. Follow Coding and Documentation Standards Maintain consistency with the project’s existing code style and structure. For non-coding contributions like documentation, ensure your additions are clear and helpful.

  2. Committing Your Changes Write Descriptive Commit Messages

Use Conventional Commits for clear and structured messages: bash Copy code git commit -m "feat: added a user guide section" Examples of commit message prefixes: feat: For new features fix: For bug fixes docs: For documentation changes style: For code formatting, no code change refactor: For code refactoring Push Your Changes to GitHub

Push your branch to your GitHub fork: bash Copy code git push origin feature/your-feature-name

  1. Opening a Pull Request Go to the Original Repository on GitHub

Navigate to the main Viewer repository. Open a Pull Request (PR)

Click the “New Pull Request” button, and make sure you’re comparing your branch with the main branch of the original repo. Provide a clear and detailed PR title and description, including: The purpose of the changes. The issue number (if applicable). A brief explanation of the solution or feature added. Wait for Feedback and Make Any Requested Changes

The project maintainers will review your PR and may request changes. Be responsive to feedback, and make any adjustments as needed.

  1. General Tips for Contributors Check for Existing Issues

Before starting work, look for open issues related to your contribution. This prevents duplicate efforts and helps maintainers track progress. Stay Engaged

Watch the repo for updates, join discussions, and feel free to ask questions in issues if you need help.

Thank You for Contributing! Your contribution, whether big or small, is greatly appreciated and helps make Viewer a better platform for everyone. Thank you for being part of our community!