Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 2.28 KB
Raw

Contributing to Site Builder

Thank you for your interest in contributing to Site Builder! We welcome contributions from the community to help improve and grow the project. Please read the following guidelines to get started.

How to Contribute

1. Reporting Issues

  • If you find a bug or have a suggestion, please open an issue in the GitHub Issues section.
  • Provide as much detail as possible, including steps to reproduce the issue, screenshots, and any relevant error messages.

2. Submitting Pull Requests

  • Fork the Repository: Start by forking the repository to your GitHub account.
  • Create a Branch: Create a new branch for your feature or bug fix. 
    git checkout -b feature/your-feature-name
  • Make Your Changes: Implement your changes, ensuring that your code follows the project's coding standards.
  • Test Your Changes: Run any necessary tests to verify that your changes work as expected.
  • Commit and Push: Commit your changes with a descriptive commit message and push to your forked repository. 
    git add .
git commit -m "Add feature/fix for XYZ"
git push origin feature/your-feature-name
  • Submit a Pull Request: Go to the original repository and open a pull request (PR). Provide a clear description of your changes and the problem they solve.

3. Coding Standards

  • Write clear, concise, and well-documented code.
  • Follow the existing code style and formatting used in the project.
  • Ensure your code passes all tests and linting checks.

4. Code Reviews

  • All pull requests will undergo code review by project maintainers.
  • Be prepared to make revisions based on feedback.

5. Adding New Features

  • Before starting work on a new feature, it's a good idea to open an issue to discuss your idea with the maintainers.
  • Ensure that your feature aligns with the project's goals and architecture.

Community Guidelines

  • Be respectful and considerate in all communications.
  • Keep discussions focused on the technical aspects of the project.
  • Report any unacceptable behavior to the project maintainers.

License

By contributing to Site Builder, you agree that your contributions will be licensed under the MIT License.