-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #45 from samyak-aditya/sam_contributing.md
Fixes #41 : Update `CONTRIBUTING.md` with clearer guidelines and structure
- Loading branch information
Showing
2 changed files
with
68 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <branch_name> | ||
``` | ||
- 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! ❤️ | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters