Skip to content

Latest commit

 

History

History
67 lines (38 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

67 lines (38 loc) · 2.79 KB
Raw

How Can I Contribute?

Reporting Bugs

If you encounter any bugs or issues with the project, please open a GitHub issue with a clear and descriptive title, along with steps to reproduce the problem if possible. Providing relevant details, such as the version of the project, your operating system, and any error messages you encountered, will help us address the issue more effectively.

Suggesting Enhancements

We also welcome suggestions for new features or enhancements to existing functionality. Feel free to open an issue on GitHub to discuss your ideas, providing as much context and detail as possible.

Pull Requests

We encourage you to submit pull requests to contribute code changes, fixes, or new features to the project. Before submitting a pull request, please ensure that:

  • Your code follows the project's coding conventions and style guidelines.
  • You have added appropriate tests for any new functionality or changes.
  • Your commits are well-documented and include clear, concise commit messages.

When submitting a pull request, please provide a brief description of the changes introduced and reference any related GitHub issues. We will review your pull request as soon as possible and provide feedback or merge it if appropriate.

Getting Started

If you're new to contributing to open-source projects or need some guidance on getting started, here are a few steps you can follow:

  1. Fork the Repository: Start by forking the project repository on GitHub to your own account.

  2. Clone the Repository: Clone your fork of the repository to your local machine using Git:

git clone https://github.com/thesayfulla/catsay.git
  1. Create a Branch: Create a new branch for your changes:
git checkout -b my-feature-branch

  1. Make Changes: Make your desired changes to the codebase.

  2. Test Your Changes: Ensure that your changes work as expected and don't introduce any regressions.

  3. Commit Your Changes: Commit your changes with descriptive commit messages:

git commit -m "Add new feature"
  1. Push Changes: Push your changes to your fork on GitHub:
git push origin my-feature-branch
  1. Open a Pull Request: Once you have pushed your changes to GitHub, open a pull request against the main branch of the original repository.

Code of Conduct

Please note that all contributors are expected to adhere to the project's code of conduct. We strive to maintain a welcoming and inclusive community for everyone.

Thank You

We appreciate your interest in contributing to catsay! Your contributions help improve the project for everyone. If you have any questions or need further assistance, feel free to reach out to us via GitHub issues or email.

Happy coding! 🚀