Skip to content

Commit

Permalink
chore(update): CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Enforcing issue based task to work in here or contributing
  • Loading branch information
mahabubx7 authored Oct 19, 2024
1 parent 23fae13 commit da5fc6c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,22 @@ Thank you for considering contributing to this project! Here’s a quick guide t
git clone https://github.com/mahabubx7/akar.git
cd akar
```
3. **Get Assigned or Make a proposal first**
- Before you start working, please choose your task first or make proposal for something that is missing or might be good for our package. Then ask for approval/assign to that. Remember, you must open or get assigned to an issue first. Then you can refer that issue in commits (optional for now) and push your work.

3. **Create a New Branch**:
5. **Create a New Branch**:
- Before making changes, create a new branch based on the `main` branch:
```bash
git checkout -b feature/your-feature-name
```

4. **Install Dependencies**:
6. **Install Dependencies**:
- Install the project dependencies:
```bash
npm install
```

5. **Run Tests**:
7. **Run Tests**:
- Make sure your changes don't break anything by running the tests:
```bash
npm test
Expand Down

0 comments on commit da5fc6c

Please sign in to comment.