Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 2.8 KB
Raw

Contributing to Fuelish

Thank you for considering contributing to Fuelish! We appreciate your interest in helping us improve and grow our project. By contributing, you become part of our community, and we value your input.❤️❤️

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme

Ways to Contribute

There are several ways you can contribute to our project:

  1. Report Bugs: If you encounter a bug or issue, please open an issue on our GitHub repository. Be sure to provide detailed information about the problem, including steps to reproduce it.

  2. Suggest Features: If you have ideas for new features or improvements, feel free to create an issue and describe your suggestions. We encourage open discussions about potential enhancements.

  3. Code Contributions: If you're a developer, you can contribute code to the project. To do so, follow these steps:

    1. Fork the repository.
    2. Create a new branch: git checkout -b my-feature-branch
    3. Make your changes and commit them: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-feature-branch
    5. Submit a pull request, and we'll consider it (as long as it's not just a request to add a feature that tells jokes).

  4. Documentation: Contributions to project documentation are also highly valuable. If you spot any inaccuracies, typos, or gaps in our documentation, please feel free to submit changes or improvements.

Getting Started

Before you start contributing, please follow these steps:

  1. Review our Code of Conduct. We expect all contributors to adhere to these guidelines.

  2. Familiarize yourself with our License. By contributing to this project, you agree to license your contributions under the terms of this license.

  3. If you're planning to submit code changes, make sure you have Git installed and a GitHub account.

Issues and Pull Requests

When submitting issues and pull requests, please adhere to the following guidelines:

  • Use clear and descriptive titles.
  • Provide detailed descriptions of the issue or the changes made.
  • Include steps to reproduce any reported bugs.
  • Be responsive to comments and feedback on your contributions.

Important: Please do not ask for assignment before creating a pull request. We encourage you to directly create a pull request for your contributions.

License

By contributing to Fuelish, you agree that your contributions will be licensed under our License.

Thank you for your interest in contributing to our project. Your help is greatly appreciated!

Happy coding!❤️