diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..0445370 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,67 @@ + + +# Contributing to LibraryMan-API + +Thank you for considering contributing to LibraryMan! We welcome contributions from everyone. Before you get started, please review our contribution guidelines below. + +## Table of Contents +- [Getting Started](#getting-started) +- [Opening a Pull Request](#opening-a-pull-request) +- [Contribution Guidelines](#contribution-guidelines) +- [Commit Messages](#commit-messages) +- [Creating Issues](#creating-issues) +- [Giving Feedback](#giving-feedback) + +## Getting Started + +1. **Fork the repository** to your own GitHub account. +2. **Clone the repository** to your local machine: + ```bash + git clone https://github.com/YOUR_USERNAME/LibraryMan-API.git + ``` +3. **Set up the project** by following the instructions in the `README.md` file. +4. **Make the changes** you want to contribute to the project. +5. **Test your code** before submitting the pull request. + +## Opening a Pull Request + +In brief: +- Commit your changes and ensure your commit messages adhere to the guidelines. +- Create a new branch for your changes: + ```bash + git checkout -b + ``` +- Open a pull request and wait for approval from the maintainer to merge your changes. + +## Contribution Guidelines + +- Contributions such as low-code improvements, new features, and bug fixes are highly appreciated. +- Feel free to open issues regarding bugs, doubts, or setup problems. +- Be polite and interactive with other contributors; maintain a respectful environment. +- Always test your code before submitting a pull request. +- Use clear and descriptive titles for your pull requests summarizing your changes. +- If your pull request addresses an issue, include the issue number in the PR title. + +## Commit Messages + +- Use meaningful commit messages related to your changes. +- Prefix your commit messages with the following: + - `fix:` for bug fixes. + - `feat:` for new features. + - `docs:` for documentation updates. + - `chore:` for miscellaneous changes. + +## Creating Issues + +- Use a clear and descriptive title for your issue. +- Provide references (links, file paths, screenshots) related to the issue. + +- When suggesting new features, describe them in detail, including where you envision them in the project. + +## Giving Feedback + +If you enjoy working with us, please give the project a ⭐ star! Your support means a lot and encourages further contributions. + +Thank you for your interest in LibraryMan-API! We look forward to your contributions! ❤️ + + diff --git a/README.md b/README.md index 6b901f3..7c399b6 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Feel free to explore and use these project. If you encounter any issues or have Contributions are always welcome! ✨ -See [`contributing.md`](https://github.com/ajaynegi45/Library-API/blob/main/contributing.md) for ways to get started. +See [`contributing.md`](https://github.com/ajaynegi45/Library-API/blob/main/Contributing.md) for ways to get started. Please adhere to this project's [`code_of_conduct.md`](https://github.com/ajaynegi45/Library-API/blob/main/code_of_conduct.md).