Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

79 lines (50 loc) · 3.33 KB
Raw

Contributing to capstone-rails

Welcome to Capstone Rails! We appreciate your interest in contributing. This document outlines the guidelines for contributing to this project and how you can get involved.

Table of Contents

Introduction

Capstone Rails is an open-source project aimed at building a powerful and scalable web application using Ruby on Rails. We welcome contributions from anyone interested in improving or adding new features to the project.

Ways to Contribute

There are several ways you can contribute to the project:

  1. Reporting Bugs: If you encounter any issues or bugs while using Capstone Rails, please submit a detailed bug report.
  2. Suggesting Enhancements: If you have ideas for new features or improvements, we encourage you to submit enhancement suggestions.
  3. Writing Code: You can contribute by writing code to fix bugs, implement new features, or improve existing functionality.
  4. Documentation: Help improve the project's documentation by fixing errors, adding examples, or clarifying existing content.
  5. Testing: You can contribute by testing the project, verifying bug fixes, or validating new features.
  6. Providing Feedback: Share your experience, give feedback on existing features, or propose improvements.

Getting Started

To get started with contributing to Capstone Rails, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Set up the project by following the instructions in the README file.
  4. Create a new branch for your contributions.
  5. Make your changes or additions.
  6. Commit your changes with a descriptive commit message.
  7. Push your changes to your forked repository.
  8. Submit a pull request to the main repository, explaining the changes you have made.

Guidelines

To ensure a smooth and effective contribution process, please adhere to the following guidelines:

  • Follow the coding style and conventions used in the project.
  • Write clear and concise commit messages.
  • Provide detailed descriptions for bug reports and enhancement suggestions.
  • Test your changes thoroughly before submitting a pull request.
  • Be respectful and considerate when interacting with other contributors.

Code of Conduct

Contributors are expected to adhere to the project's Code of Conduct. Please read the CODE_OF_CONDUCT.md for more details.

Support

If you need any help or have questions about Capstone Rails, feel free to reach out to us through [contact information or channels].

Thank you for your interest in contributing to Capstone Rails. Your contributions are greatly appreciated!

We encourage you to familiarize yourself with this document before making any contributions. Happy contributing!

👨‍💻 Authors

👤 Ahmed Hasan Rony

Please Reach out to any of the Authors if you want to contribute

Email ME : ahmed.hasan.rony@gmail.com

Happy Coding 🙃