Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 2.46 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! GitSpitLight 🐙

We appreciate your efforts in making this project better. Please take a moment to review these guidelines before getting started.

Table of Contents

Getting Started

  1. Fork the repository and clone it to your local machine.
  2. Install the necessary dependencies.
  3. Create a new branch for your changes: git checkout -b feature/issue_number.
  4. Make your modifications and ensure the code builds successfully.
  5. Run the tests, if available, to ensure they pass.
  6. Commit your changes: git commit -m "Add your commit message".
  7. Push your changes to your forked repository: git push origin feature/your-feature-name.
  8. Submit a pull request to the main repository.

Code Style and Guidelines

  • Follow the established coding style and conventions used in the project.
  • Ensure your code is well-documented and includes clear comments where necessary.
  • Write meaningful commit messages and provide a brief description of your changes in the pull request.
  • Include any necessary documentation updates related to your changes.

Reporting Issues

  • Before opening a new issue, search the existing issues to avoid duplicates.
  • Clearly describe the issue, including steps to reproduce if applicable.
  • Provide any relevant details, such as error messages or screenshots.
  • Specify the version of the project or dependencies being used.

Pull Request Guidelines

  • Make sure your pull request addresses an existing issue or feature request.
  • Provide a clear and concise description of the changes made.
  • Include any necessary documentation updates related to your changes.
  • All tests should pass successfully, or new tests should be added to cover the changes.

Community and Communication

  • Join our official Gitter Channel.
  • Be respectful and considerate of other contributors.
  • If you need any assistance or have questions, feel free to reach out to our team.
  • We welcome all kinds of contributions, including code improvements, bug fixes, documentation updates, and feature implementations.

Thank you for your contributions! Together, we can make this project even better.