Skip to content

Commit 0d0fc6a

Browse files
committed
Add main.yml in workflows
1 parent 0ab61a2 commit 0d0fc6a

File tree

4 files changed

+603
-233
lines changed

4 files changed

+603
-233
lines changed

.github/workflows/main.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,11 @@ jobs:
7171
- name: Set up Docker Buildx
7272
uses: docker/setup-buildx-action@v2
7373

74+
- name: Debug Secrets
75+
run: |
76+
echo "DOCKER_USERNAME: ${{ env.DOCKER_USERNAME }}"
77+
echo "DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}"
78+
7479
- name: Login to DockerHub
7580
uses: docker/login-action@v2
7681
with:
@@ -188,4 +193,4 @@ jobs:
188193
if: always()
189194
run: |
190195
docker-compose -f docker/docker-compose.full.yml down
191-
docker logout
196+
docker logout

CONTRIBUTING.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Contributing to Semantic Search
2+
3+
We love your input! We want to make contributing to Semantic Search as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## 🚀 Getting Started
12+
13+
1. Fork the repository
14+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
15+
3. Read our [Development Guide](DEVELOPMENT.md)
16+
4. Make your changes
17+
5. Commit your changes (`git commit -m 'feat: add amazing feature'`)
18+
6. Push to the branch (`git push origin feature/amazing-feature`)
19+
7. Open a Pull Request
20+
21+
## 📝 Development Process
22+
23+
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
24+
25+
1. Fork the repo and create your branch from `main`.
26+
2. If you've added code that should be tested, add tests.
27+
3. If you've changed APIs, update the documentation.
28+
4. Ensure the test suite passes.
29+
5. Make sure your code follows our coding standards.
30+
6. Issue that pull request!
31+
32+
## 📋 Pull Request Process
33+
34+
1. Update the README.md with details of changes to the interface, if applicable.
35+
2. Update the CHANGELOG.md with a note describing your changes.
36+
3. The PR will be merged once you have the sign-off of at least one maintainer.
37+
38+
## 🐛 Report bugs using GitHub's [issue tracker]
39+
40+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/yourusername/semantic-search/issues/new).
41+
42+
### Write bug reports with detail, background, and sample code
43+
44+
**Great Bug Reports** tend to have:
45+
46+
- A quick summary and/or background
47+
- Steps to reproduce
48+
- Be specific!
49+
- Give sample code if you can.
50+
- What you expected would happen
51+
- What actually happens
52+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
53+
54+
## 📖 Documentation
55+
56+
- Keep documentation up to date
57+
- Use clear and consistent terminology
58+
- Include code examples where appropriate
59+
- Document both success and error scenarios
60+
61+
## 🔍 Code Review Process
62+
63+
The core team looks at Pull Requests on a regular basis.
64+
After feedback has been given we expect responses within two weeks. After two weeks we may close the PR if it isn't showing any activity.
65+
66+
## 🎨 Coding Style
67+
68+
- We use Black for Python code formatting
69+
- Follow PEP 8 guidelines
70+
- Write meaningful commit messages following [Conventional Commits](https://www.conventionalcommits.org/)
71+
- Include type hints
72+
- Add docstrings to functions and classes
73+
74+
## 🔒 Security
75+
76+
- Never commit API keys or secrets
77+
- Report security vulnerabilities privately
78+
- Follow secure coding practices
79+
- Keep dependencies updated
80+
81+
## ⚖️ License
82+
83+
By contributing, you agree that your contributions will be licensed under its MIT License.
84+
85+
## 🙏 Attribution
86+
87+
This Contributing Guide is adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).

0 commit comments

Comments
 (0)