Skip to content

contributing.md

Latest commit

 

History

History
129 lines (86 loc) · 7.18 KB

contributing.md

File metadata and controls

129 lines (86 loc) · 7.18 KB

Contributing

Welcome! Thank you for considering contributing to zunalita/posts! This project thrives because of the amazing contributions from the community, and we are grateful for your interest in making it even better.

Before you start, please review the following guidelines to ensure a smooth contribution process. These guidelines cover everything from how to report issues to how to submit pull requests, and what we expect from contributors.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
    1. Reporting Issues
    2. Creating Pull Requests
  3. Branching and Commit Guidelines
  4. Code Standards
  5. Testing Your Changes
  6. License
  7. Disclaimers and Limitation of Liability

Code of Conduct

As a contributor, you are expected to abide by the project's Code of Conduct. Our community is meant to be inclusive, welcoming, and respectful for all participants, regardless of their background or experience.

  • Be respectful of others' time and contributions.
  • Provide constructive feedback, and avoid personal attacks or offensive language.
  • If you see issues with any contributor's behavior or a violation of these guidelines, please contact the maintainers immediately.

How to Contribute

Reporting Issues

If you find a bug or would like to suggest an improvement, please open an issue in the Issues section. When reporting bugs or requesting features, try to provide the following information:

  • Detailed description of the problem/feature.
  • Steps to reproduce (for bugs).
  • Expected and actual results.
  • Screenshots, logs, or error messages (if applicable).
  • Your environment (e.g., operating system, browser version, etc.).

Creating Pull Requests

We welcome pull requests! Please follow these steps to submit your contributions:

  1. Fork the repository: Click the "Fork" button on GitHub to create a copy of the repository under your account.
  2. Create a branch: Before making any changes, create a new branch from main (or the latest development branch). The name of the branch should clearly indicate the purpose of your changes (e.g., fix-typo, add-new-feature).
  3. Make changes: Make your changes, ensuring that they follow the Code Standards outlined below.
  4. Write tests: If applicable, write tests to cover your changes. Tests should be clear, concise, and comprehensive.
  5. Commit your changes: Write a detailed commit message that explains the changes made and why they were necessary. Follow the Commit Guidelines.
  6. Push your changes: Push your changes to your forked repository and create a pull request against the main branch of the original repository.
  7. Describe your pull request: Provide a summary of the changes in your pull request description, and link to any relevant issues.

Branching and Commit Guidelines

  • Branch names should be short, descriptive, and follow the format: type/short-description. Examples: bugfix/typo-in-readme, feature/new-ui.
  • Commit messages should follow this pattern:
    • [Type]: A brief subject of the change.
    • Body: Explain the why and how of the change (optional but encouraged).
    • Example: 
      [Fix] Corrected the typo in README
Fixed a typo in the usage section of the README to improve clarity.
  • Types: Use these common commit types:
    • Fix: Bug fixes or patches.
    • Feature: New features or significant improvements.
    • Docs: Documentation updates.
    • Refactor: Code cleanup or restructuring.
    • Test: Adding or modifying tests.
    • Chore: Miscellaneous tasks or maintenance.

Code Standards

To ensure consistency and maintainability of the codebase, please follow the coding standards below:

  • Language-specific guidelines: Ensure your changes follow the coding conventions for the language used in the project (e.g., JavaScript, Python, etc.).
  • Indentation: Use spaces for indentation (2 spaces per level).
  • Line Length: Limit lines of code to a maximum of 80 characters for readability.
  • Naming Conventions: Use meaningful and descriptive names for variables, functions, classes, and files.
  • Documentation: All public functions and classes should be documented with appropriate comments.

If you’re unsure about something, feel free to ask the maintainers for clarification!

Testing Your Changes

Before submitting your pull request, it’s important to make sure your changes work as expected.

  1. Write unit tests for your changes if applicable.
  2. Run tests locally: Make sure your changes do not break existing functionality.
  3. Check coverage: Ensure sufficient test coverage for your changes.
  4. Test manually: If applicable, test the software manually to ensure that the changes integrate properly with the rest of the system.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project. The project is licensed under the MIT License.

See the LICENSE file for more details.

Disclaimers and Limitation of Liability

No Liability for Changes Not Made by Zunalita Editorial Team

By contributing to this project, you acknowledge and agree to the following terms:

  • Changes Made by Contributors: The Zunalita Editorial Team holds full responsibility for all official changes, updates, and releases in the project. Any changes, modifications, or additions made by contributors do not fall under the responsibility or liability of the Zunalita Editorial Team unless explicitly reviewed, approved, and merged by the team.

  • Unapproved Modifications: Any modifications made outside the scope of official contributions or without the editorial team’s approval are made at the contributor’s own risk. The Zunalita Editorial Team does not assume any liability for these modifications, and they may not be included in the official project.

  • No Warranty: The project is provided "as is" without warranties of any kind, either express or implied, including but not limited to warranties of fitness for a particular purpose, reliability, or accuracy. The Zunalita Editorial Team does not guarantee that any of the content, features, or functionalities of the project will be error-free, and we do not accept any responsibility for issues arising from its use, modification, or distribution.

  • Indemnity: You agree to indemnify and hold harmless the Zunalita Editorial Team, its affiliates, and contributors from any claims, losses, liabilities, and expenses arising from the changes, modifications, or content you contribute.

  • Changes and Withdrawals: The Zunalita Editorial Team reserves the right to review, accept, reject, or withdraw any contributions at its sole discretion, without the need to provide justification or notice.

By submitting a pull request, you acknowledge and accept these terms.