Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the contribution guidelines in Readme . #63

Merged
merged 2 commits into from
Jun 2, 2024
Merged

Updating the contribution guidelines in Readme . #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b81e9f2
Update README.md
Sibam-Paul May 29, 2024
450c5fb
Update README.md
Sibam-Paul May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 44 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,49 @@ Once the School Management System plugin is activated, you can start using its v
We welcome contributions from the open-source community to enhance and improve the School Management System WordPress plugin. If you'd like to contribute, please follow these guidelines:

1. Fork the repository.

2. Create a new branch for your changes.

3. Make your changes and commit them.

4. Submit a pull request to the main repository.
2. Clone your forked repository of the project.
```
$ git clone https://github.com/<your_username>/repository_name.git
```
3. Navigate to the project directory.
```
$ cd school-management
```
4. Add a reference(remote) to the original repository.
```
$ git remote add upstream https://github.com/repository_owner/repository_name.git
```
5. Check the remotes for this repository.
```
$ git remote -v
```
6. Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository.
```
$ git pull upstream main
```
7. Create a new branch (prefer a branch name that relates to your assigned issue).
```
$ git checkout -b <YOUR_BRANCH_NAME>
```
8. After making the required changes. Check your changes.
```
$ git status OR git diff
```
9. Stage your changes.
```
$ git add . <\files_that_you_made_changes>
```
10. Commit your changes.
```
$ git commit -m "relavant message"
```
9. Push the committed changes in your feature branch to your remote repository.
```
$ git push -u origin <your_branch_name>
```
10. To create a pull request, click on compare and pull request.
11. Add an appropriate title and description to your PR explaining your changes.
12. Click on Create pull request.


>### Contributors using Visual Studio Code (VS Code)
Expand All @@ -90,4 +127,4 @@ This School Management System WordPress plugin is released under the [GNU GENERA

For any questions or support, feel free to contact us at [[email protected]](mailto:[email protected])

We hope the School Management System plugin helps you efficiently manage your educational institution. Thank you for using our plugin!
We hope the School Management System plugin helps you efficiently manage your educational institution. Thank you for using our plugin!
Loading