Skip to content

Commit 5e92345

Browse files
Updated the Contributing.md
1 parent 5205fb4 commit 5e92345

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

contributing.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to DSC_Chuka
2+
3+
We are excited to have you contribute to our React project! This document provides guidelines and instructions to help you get started.
4+
5+
## Getting Started
6+
7+
Before you begin, make sure you have the following installed:
8+
- Node.js version 18 or above
9+
- npm or yarn
10+
11+
Fork the repository and clone it locally. Install the dependencies by running `npm install` or `yarn`.
12+
13+
## Development Workflow
14+
15+
1. **Create a branch:** For each new feature or fix, create a new branch from `main`.
16+
git checkout -b your-branch-name
17+
2. **Make your changes:** Write code and tests that adhere to the project's coding standards.
18+
3. **Test your changes:** Ensure that all tests pass and your changes do not break existing functionality.
19+
npm test
20+
4. **Lint your code:** Make sure your code is clean and follows the project's style guide.
21+
npm run lint
22+
23+
## Committing Your Changes
24+
25+
- Write clear and meaningful commit messages.
26+
- Include any relevant issue numbers in your commit messages.
27+
- Push your commits to your branch in your fork.
28+
29+
## Creating a Pull Request
30+
31+
- Navigate to the original repository you forked from.
32+
- Click the "New pull request" button and select your branch.
33+
- Clearly describe the purpose of your pull request in the title and description.
34+
- Link any relevant issues.
35+
36+
## Code Review
37+
38+
Once you submit your pull request, maintainers will review your code. Be responsive to feedback and make necessary changes if requested.
39+
40+
## Community Guidelines
41+
42+
- Be respectful and constructive in your communication.
43+
- Follow our Code of Conduct
44+
45+
Thank you for contributing to DSC_Chuka! We look forward to your contribution.
46+
47+
---
48+
49+
This CONTRIBUTING guide is a living document and may change over time. Feel free to suggest improvements or changes by opening an issue or a pull request.

0 commit comments

Comments
 (0)