Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 3.07 KB

contributing.md

File metadata and controls

69 lines (44 loc) · 3.07 KB

SnapScale - Contribution Guidelines

Thank you for considering contributing to SnapScale! We welcome contributions from the open-source community to help make image resizing easier and more accessible for everyone. Here are some guidelines to follow when contributing to this project:

Getting Started

Before you start contributing to SnapScale, make sure you have the following prerequisites:

  • Basic knowledge of image resizing and manipulation.
  • Familiarity with Git and GitHub for version control.
  • Node.js and npm installed on your local machine.
  • A code editor of your choice (e.g., Visual Studio Code, Sublime Text).

Setting up the Development Environment

To set up the development environment for SnapScale, follow these steps:

  1. Fork the Repository: Click the "Fork" button on the SnapScale GitHub repository to create your own copy.

  2. Clone Your Fork: Use Git to clone your forked repository to your local machine.

    git clone https://github.com/your-username/SnapScale.git
cd SnapScale

  3. Install Dependencies: Use npm to install the project dependencies.

    npm install

  4. Run the Application: Start the SnapScale application to ensure it's working as expected.

    npm start

Contributing Guidelines

When contributing to SnapScale, please follow these guidelines:

  1. Create a New Branch: Always create a new branch for your contributions. Name your branch with a descriptive and concise title.

    git checkout -b feature/your-feature-name

  2. Keep Commits Atomic: Make sure your commits are concise and cover a single logical change. Use descriptive commit messages.

   git commit -m "Add feature X"

  1. Testing: If you're adding a new feature, make sure to add appropriate tests. If you're fixing a bug, create a test case to reproduce the issue.

  2. Code Style: Follow the existing code style and conventions in the project. Use consistent indentation and naming.

  3. Documentation: If you add new features or make changes, please update the project's documentation to reflect these changes.

  4. Pull Requests: When you're ready to submit your contribution, open a pull request (PR) to the main repository. Provide a clear and concise description of your changes in the PR.

  5. Code Review: Be prepared to address feedback and comments during the code review process. Be open to discussions and improvements.

Reporting Issues

If you encounter a bug, have a feature request, or want to discuss improvements, please open an issue on the SnapScale GitHub repository. When reporting issues, include as much detail as possible to help us understand and reproduce the problem.

License

By contributing to SnapScale, you agree that your contributions will be licensed under the project's open-source license. Please read the License file for more information.

We appreciate your contributions to make SnapScale a more user-friendly and efficient image resizing tool! Thank you for your support. 🚀📷