Skip to content

Commit c576889

Browse files
committed
initial commit
0 parents commit c576889

13 files changed

+1043
-0
lines changed

.gitignore

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# dependencies
2+
node_modules/
3+
4+
# build output
5+
dist/
6+
out-tsc/
7+
*.js.map
8+
9+
# IDEs
10+
.idea/
11+
.vscode/
12+
*.swp
13+
*.swo
14+
*~
15+
16+
# misc
17+
.DS_Store
18+
Thumbs.db
19+
*.log
20+
npm-debug.log*
21+
yarn-debug.log*
22+
yarn-error.log*
23+
24+
# testing
25+
coverage/
26+
27+
# package manager
28+
package-lock.json
29+
yarn.lock
30+
pnpm-lock.yaml

CONTRIBUTING.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributing to ngx-apexgantt
2+
3+
Thank you for considering contributing to ngx-apexgantt! We welcome contributions from the community.
4+
5+
## How to Contribute
6+
7+
### Reporting Bugs
8+
9+
If you find a bug, please open an issue with:
10+
11+
- A clear title and description
12+
- Steps to reproduce the issue
13+
- Expected vs actual behavior
14+
- Angular version and ngx-apexgantt version
15+
- Code samples or screenshots if applicable
16+
17+
### Suggesting Enhancements
18+
19+
Enhancement suggestions are welcome! Please open an issue with:
20+
21+
- A clear title and description
22+
- Explanation of why this enhancement would be useful
23+
- Examples of how it would work
24+
25+
### Pull Requests
26+
27+
1. Fork the repository
28+
2. Create a new branch (`git checkout -b feature/your-feature-name`)
29+
3. Make your changes
30+
4. Commit your changes (`git commit -am 'Add some feature'`)
31+
5. Push to the branch (`git push origin feature/your-feature-name`)
32+
6. Open a Pull Request
33+
34+
#### Pull Request Guidelines
35+
36+
- Follow the existing code style
37+
- Write clear commit messages
38+
- Update documentation if needed
39+
- Test your changes thoroughly
40+
- Keep pull requests focused on a single feature/fix
41+
42+
## Development Setup
43+
44+
```bash
45+
# clone the repository
46+
git clone https://github.com/your-username/ngx-apexgantt.git
47+
cd ngx-apexgantt
48+
49+
# install dependencies
50+
npm install
51+
52+
# build the library
53+
npm run build
54+
55+
# watch mode for development
56+
npm run watch
57+
```
58+
59+
## Code Style
60+
61+
- Use TypeScript strict mode
62+
- Follow Angular style guide
63+
- Use meaningful variable and function names
64+
- Add comments for complex logic
65+
- Keep functions small and focused
66+
67+
## Testing
68+
69+
Currently, tests are not included in the initial release. Contributions to add comprehensive test coverage are welcome!
70+
71+
## Questions?
72+
73+
Feel free to open an issue for any questions about contributing.
74+
75+
Thank you for contributing! 🎉

0 commit comments

Comments
 (0)