Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

62 lines (39 loc) · 3.4 KB
Raw

Contributing to Snippit

👍🎉 First off, thank you for your interest in contributing to Snippit! 👍🎉

We welcome contributions from everyone, regardless of your experience level. This document outlines the guidelines and steps to help you get started with contributing to our project.

Getting Started

  1. Ensure you have a GitHub account.
  2. Fork the repository on GitHub.
  3. Clone the forked repository to your local machine.
  4. Set up the development environment as described in the project's README file.
  5. Familiarize yourself with the codebase and project structure.

Finding Tasks

If you're unsure where to begin, here are some ideas for contributing:

  • Tackle existing issues labeled as good first issue.
  • Improve the documentation by fixing typos, clarifying explanations, or adding examples.
  • Implement missing features or enhance existing functionality.
  • Write additional test cases to improve test coverage.
  • Review and provide feedback on open pull requests.

Opening Issues

If you encounter a bug, have a feature request, or need assistance, please follow these guidelines when reporting issues:

  1. Check Existing Issues: Before submitting a new issue, check if a similar one already exists to avoid duplicates.
  2. Provide Clear Details: When reporting an issue, provide clear details to help us understand and reproduce the problem. Include a descriptive title, steps to reproduce, expected and actual behavior, error messages, project version, and your operating system.
  3. Be Respectful and Patient: Interact respectfully with others in the issue tracker. Contribute insights or offer assistance when possible.

Making Changes

  1. Create a new branch in your local repository. Choose a descriptive name that reflects the nature of your changes.
  2. Make your desired changes in the codebase.
  3. Commit your changes with clear and concise messages. Please follow the project's commit message guidelines.
  4. Push your changes to your forked repository on GitHub.
  5. Submit a pull request (PR) to the main repository's main branch.
  6. Engage in the PR discussion. Be open to feedback and address any requested changes.

Code Style and Guidelines

Please follow the project's code style and guidelines when making changes. If there aren't any specific guidelines mentioned, strive to maintain consistency with the surrounding codebase.

Tests

If applicable, ensure that your changes include appropriate test coverage. Run the existing tests and add new ones to cover the modified code. Make sure all tests pass before submitting your pull request.

Documentation

If your changes affect the project's documentation, please update it accordingly. This includes README files, inline code comments, or any other relevant documentation.

Code Review

Your pull request will undergo a review by the project maintainers. Please be patient and responsive during this process. Be open to feedback, address any review comments, and make necessary changes.

Conclusion

Thank you for considering to contribute to Snippit! Your contributions are valuable and help improve the project. Remember, if you have any questions or need assistance, feel free to reach out by opening an issue or contacting directly to us.

Happy contributing!