-
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.
Merge remote-tracking branch 'origin/master'
- Loading branch information
Showing
1 changed file
with
65 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,65 @@ | ||
# Contributing to crudmodule | ||
|
||
Thank you for considering contributing to crudmodule! We welcome contributions of all kinds: new features, bug fixes, documentation improvements, and more. | ||
|
||
## Getting Started | ||
|
||
### 1. Fork the Repository | ||
|
||
Fork the repository by clicking the "Fork" button on the top right of the repository page. | ||
|
||
### 2. Clone the Repository | ||
|
||
Clone your forked repository to your local machine: | ||
|
||
```sh | ||
git clone https://github.com/kha333n/crudmodule.git | ||
cd crudmodule | ||
``` | ||
|
||
### 3. Check Out the dev Branch | ||
Check out the dev branch and pull the latest changes: | ||
|
||
```sh | ||
git checkout dev | ||
git pull upstream dev | ||
``` | ||
|
||
### 4. Making Changes | ||
Create a new branch for your feature or bug fix: | ||
|
||
```sh | ||
git checkout -b feature-or-bugfix-name | ||
``` | ||
### 5. Make Your Changes | ||
Make your changes in the new branch. Be sure to follow the project's coding standards and include appropriate tests. | ||
|
||
### 6. Commit Your Changes | ||
Commit your changes with a descriptive commit message: | ||
|
||
```sh | ||
git add . | ||
git commit -m "Description of changes" | ||
``` | ||
|
||
### 7. Push Your Changes | ||
Push your changes to your forked repository: | ||
|
||
```sh | ||
git push origin feature-or-bugfix-name | ||
``` | ||
### 8. Create a Pull Request | ||
Go to the original repository and click on the "New Pull Request" button. Select your branch from the list of branches and click "Create Pull Request". Provide a descriptive title and a detailed description of your changes. | ||
|
||
### Code Review Process | ||
All pull requests will be reviewed by the maintainers. Here are some guidelines to follow: | ||
|
||
* Ensure your code follows the project's coding standards. | ||
* Provide a detailed description of your changes. | ||
* Address any feedback from the maintainers promptly. | ||
* Additional Notes | ||
* Please create pull requests to the dev branch, not the master branch. | ||
* Keep your pull requests focused on a single issue or feature. Large pull requests are difficult to review. | ||
* Ensure that your branch is up to date with the latest changes from dev before creating a pull request. | ||
|
||
Thank you for your contributions! |