forked from Ctoic/Lisbook
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
61 additions
and
0 deletions.
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,61 @@ | ||
# Let's create the CONTRIBUTING.md markup as requested by the user | ||
# Contributing to LisBook | ||
|
||
🎉 Thank you for considering contributing to **LisBook**! We're excited to have you on board. This guide will help you get started with contributing to the project, whether you're fixing bugs, adding new features, or improving the documentation. | ||
|
||
## How to Contribute | ||
|
||
Follow these steps to get started: | ||
|
||
### 1. Fork the Repository | ||
|
||
Click the "Fork" button at the top of this repository to create a copy of LisBook under your own GitHub account. | ||
|
||
### 2. Clone Your Fork | ||
|
||
Once you've forked the repository, clone your forked copy to your local machine using the command: | ||
|
||
```bash | ||
git clone https://github.com/ctoic/lisbook.git | ||
``` | ||
|
||
### Create a Branch | ||
Create a new branch for your changes. We use the following branch naming convention: | ||
```git checkout -b feature/your-feature-name``` | ||
```git checkout -b feature/add-dark-mode``` | ||
### Making Changes | ||
Work on your changes in the new branch you created. Make sure to keep your commits focused and descriptive. For example: | ||
```git add . ``` | ||
<be> | ||
``` git commit -m "Added dark mode feature"``` | ||
|
||
### Keep your Fork Updated | ||
Before you push your changes, ensure your fork is in sync with the main repository to avoid conflicts. You can do this by fetching the latest changes: | ||
|
||
```git fetch upstream ``` | ||
```git merge upstream/main ``` | ||
### Push Your Fork | ||
```git push origin feature/your-feature-name``` | ||
|
||
### Create a Pull Request | ||
Go to the original repository on GitHub and click the "Pull Requests" tab. From there, click "New Pull Request" and select the branch with your changes. Make sure to provide a meaningful title and description for your pull request. | ||
|
||
### Wait for Review | ||
We’ll review your pull request as soon as possible. If any changes are required, we’ll leave comments. Once everything looks good, we’ll merge your contribution! | ||
|
||
## Guidelines for Contributions | ||
Write Clear Commits: Make sure your commit messages describe the changes clearly. | ||
Follow the Code Style: Try to keep your code consistent with the existing codebase. Follow any style guides specified in the project. | ||
Test Your Changes: Make sure your changes work as expected. Test your code in different scenarios to avoid bugs. | ||
Stay Respectful: Be kind and respectful in all interactions with other contributors. We value a friendly and positive community. | ||
Getting Started with Issues | ||
If you’re looking for beginner-friendly issues, check out the good first issue label in the Issues tab. These are great starting points to get familiar with the project. | ||
|
||
## During Hacktoberfest: | ||
Each pull request you submit should follow the Hacktoberfest guidelines. | ||
Make sure your pull request is meaningful and contributes to the project. | ||
If you’re new to Git, GitHub, or open-source contributions, don’t hesitate to ask questions or request help! | ||
Need Help? | ||
If you have any questions or need help getting started, feel free to open an issue or reach out to us directly through our contact links. | ||
|
||
We’re looking forward to seeing your contributions! 🚀 |