Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
metaboulie committed May 27, 2024
1 parent ad44580 commit 24f82bd
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Contributing to the University Portal Mobile App

Welcome to the University Portal Mobile App project! We appreciate your interest in contributing to this project. Your contributions can help make this app even better.
Expand All @@ -10,23 +9,30 @@ Before you get started, please take a moment to read through this document to un
1. Fork the repository to your own GitHub account.

2. Clone the forked repository to your local machine:

```
git clone [your_fork_url]
```

3. Create a new branch for your work:

```
git checkout -b feature/your-feature-name
```

4. Make your changes, improvements, or fixes.
When developing new features or experimenting with the codebase, you might want to create files that should not be tracked by Git to avoid cluttering the main repository. A common practice is to prefix these file names with a `+` sign. For example, naming a file `+experiment.py` will make it clear that this file is for personal or temporary use and should not be included in version control.

5. Commit your changes with clear and concise commit messages:

```
git commit -m "Your commit message"
```

> you can refer to this [link](https://www.conventionalcommits.org/en/v1.0.0/) for more information on conventional commits
6. Push your changes to your fork on GitHub:

```
git push origin feature/your-feature-name
```
Expand Down Expand Up @@ -67,5 +73,4 @@ Thank you for contributing to the University Portal Mobile App project!

Happy coding!


You can place this content in a `CONTRIBUTING.md` file in your project's repository. Be sure to replace `[your_fork_url]` with the URL of your forked repository and customize any other details as needed for your project's specific contribution process.

0 comments on commit 24f82bd

Please sign in to comment.