Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

75 lines (48 loc) · 3.1 KB
Raw

Contributing to sabashavidze.io

Thank you for considering contributing to the sabashavidze.io project! Contributions are valuable and greatly appreciated. This document provides guidelines to help you contribute effectively.

Ways to Contribute

  • Bug Reports: If you encounter any bugs or issues while using the website, please open an issue with a clear description of the problem. Include steps to reproduce the issue, expected behavior, and any relevant details.

  • Feature Requests: If you have ideas for new features or enhancements, feel free to open an issue to suggest your ideas. Provide a clear description and rationale for the proposed feature or enhancement.

  • Pull Requests: If you would like to contribute code changes, please follow these steps:

    1. Fork the repository and create a new branch for your contribution.
    2. Make your changes, ensuring adherence to the existing code style and conventions.
    3. Test your changes thoroughly to ensure they don't introduce new issues.
    4. Submit a pull request with a clear description of your changes, including the motivation and any relevant details.

Development Setup

To set up the project for local development, follow these steps:

  1. Clone the repository:

    git clone https://github.com/shavidze/sabashavidze.io.git

  2. Install dependencies:

    cd sabashavidze.io
npm install

    or

    cd sabashavidze.io
make install

  3. Make your desired changes and test them locally.

  4. Run the development server:

    npm run dev

    or

    make run

    This will start a local development server at http://localhost:3000.

Code Style and Guidelines

  • Follow the existing code style and conventions used in the project.
  • Write clear, self-explanatory, and well-documented code.
  • Ensure your code is formatted properly before submitting a pull request.
  • Include unit tests for new functionality or modifications to existing code.

Code of Conduct

Please note that we have a Code of Conduct in place to ensure a welcoming and inclusive environment for all contributors. By participating in this project, you are expected to adhere to the Code of Conduct. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers.

License

By contributing to the sabashavidze.io project, you agree that your contributions will be licensed under the MIT License. See the LICENSE file for more details.

Contact

If you have any questions or need further assistance, feel free to reach out through the contact form on sabashavidze.io or connect with me on LinkedIn or Twitter.

We appreciate your contributions to sabashavidze.io and look forward to your involvement!

Feel free to customize and modify this CONTRIBUTING.md template to fit your specific project guidelines and requirements.