Skip to content

Commit e91dad7

Browse files
fix: Updating workflow config
Co-authored-by: Deepraj Bera <[email protected]>
1 parent 1dab123 commit e91dad7

File tree

9 files changed

+335
-140
lines changed

9 files changed

+335
-140
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
For answers to common questions about this code of conduct, see
74+
https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# ✨ Contributing Guide
2+
3+
First off, thank you for considering contributing to DevHub! We appreciate your time and effort in helping make this project better.
4+
5+
The following is a set of guidelines for contributing to DevHub. These are just guidelines, not rules, so use your best judgment and feel free to propose changes to this document in a pull request.
6+
7+
## Table of Contents
8+
- [What can I contribute?](#what-can-i-contribute)
9+
- [Before You Contribute](#before-you-contribute)
10+
- [Your First Contribution](#your-first-contribution)
11+
- [Development Workflow](#development-workflow)
12+
- [Cloning the Repository](#cloning-the-repository)
13+
- [Creating a New Branch](#creating-a-new-branch)
14+
- [Making Changes](#making-changes)
15+
- [Submitting a Pull Request](#submitting-a-pull-request)
16+
- [Reporting Bugs](#reporting-bugs)
17+
- [How Do I Submit A Good Bug Report?](#how-do-i-submit-a-good-bug-report)
18+
- [Contribution Guidelines](#contribution-guidelines)
19+
- [Core Work Contributions](#core-work-contributions)
20+
- [Template Contributions](#template-contributions)
21+
- [Code of Conduct](#code-of-conduct)
22+
- [License](#license)
23+
24+
## What can I contribute?
25+
There are several ways to contribute to this repository:
26+
27+
1. **Feature Development**: Enhancing the feature functionalities of DevHub, including features related to matchmaking and user interaction.
28+
3. **Bug Fixes**: Identifying and resolving bugs that affect the platform's performance or user experience.
29+
30+
## Before You Contribute
31+
Before starting to contribute, please make sure to:
32+
- **Open an issue** on GitHub or discuss your idea on our [Discord](https://discord.gg/he8QHEC8WP) to get feedback and align with the project's goals.
33+
- Review the [**Code of Conduct**](https://github.com/devhub-ai/devhub/blob/main/.github/CODE_OF_CONDUCT.md) and agree to abide by it.
34+
35+
## Your First Contribution
36+
If you're unsure where to begin contributing, you can start by looking through the **good first issues** or **help wanted issues**. These issues are great starting points for new contributors.
37+
38+
## Development Workflow
39+
40+
### Cloning the Repository
41+
1. Fork the repository on GitHub.
42+
2. Clone your forked repository to your local machine.
43+
3. Navigate to the project directory in your terminal.
44+
45+
### Creating a New Branch
46+
1. Create a new branch from the `main` branch using `git checkout -b your-branch-name`.
47+
2. Choose a descriptive name for your branch, such as `feat/add-new-feature` or `fix/bug-in-matchmaking`.
48+
49+
### Making Changes
50+
1. Make your changes to the codebase.
51+
2. Ensure your changes follow the project's coding style and conventions.
52+
3. Add or update tests if necessary.
53+
54+
### Submitting a Pull Request
55+
1. Push your branch to your forked repository.
56+
2. Open a pull request from your branch to the `main` branch of the original repository.
57+
3. Fill out the pull request template with relevant information and also mention any issues it resolves (if applicable).
58+
4. Reference any related issues in the pull request description.
59+
5. Wait for maintainers to review your pull request.
60+
61+
## Reporting Bugs
62+
63+
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
64+
65+
Before creating a new issue, **perform a cursory search** to see if the report exists. If it does, go through the discussion thread and leave a comment instead of opening a new one.
66+
67+
If you find a **Closed** issue that is similar to what you are experiencing, open a new issue and include a link to the original case in your new one.
68+
69+
If you cannot find an open or closed issue addressing the problem, **open a new issue**.
70+
71+
Be sure to include:
72+
- A **clear title and description**
73+
- Relevant information
74+
- A **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
75+
76+
## Contribution Guidelines
77+
78+
79+
1. **Feature Development**: Enhancing the feature functionalities of DevHub, including features related to matchmaking and user interaction.
80+
3. **Bug Fixes**: Identifying and resolving bugs that affect the platform's performance or user experience.
81+
82+
Every template contribution should:
83+
- Include proper documentation that provides an overview of its functionality.
84+
- Contribute relevant examples or templates that enhance user experience.
85+
86+
## Code of Conduct
87+
By participating in this project, you agree to abide by our [Code of Conduct](https://github.com/devhub-ai/devhub/blob/main/.github/CODE_OF_CONDUCT.md).
88+
89+
## License
90+
DevHub is licensed under the [Apache License 2.0](https://github.com/devhub-ai/devhub/blob/main/LICENSE).
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "🐛 Bug Report"
3+
about: Report a reproducible bug or regression.
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Viable Solution**
27+
If you have a potential solution in mind, please describe it here.
28+
29+
**Additional context**
30+
Add any other context about the problem here.
31+
32+
**Checklist**
33+
- [ ] I have searched for similar issues and couldn't find a resolution.
34+
- [ ] I am willing to work on this issue and submit a pull request.
35+
- [ ] This bug is specific to my OS environment (if yes, please specify above).
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
3+
name: "✨ Feature Request"
4+
about: Suggest an amazing new idea for this project
5+
title: 'Feature: [Concise Description of the Feature]'
6+
labels: enhancement
7+
assignees: ''
8+
9+
---
10+
11+
## Feature Request
12+
13+
**Is your feature request related to a problem you're trying to solve with Devhub? Please describe.**
14+
<!-- A clear and concise description of what the problem is. Ex. I have an issue when [...] -->
15+
16+
**Describe the solution you'd like**
17+
<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->
18+
19+
**Describe alternatives you've considered**
20+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
21+
22+
**How would this feature improve Devhub?**
23+
<!-- Explain how the proposed feature would enhance the functionality and user experience of Devhub. -->
24+
25+
**Additional context**
26+
<!-- Add any other context, mockups, or screenshots about the feature request here. -->
27+
28+
## Are you willing to resolve this issue by submitting a Pull Request?
29+
30+
<!--
31+
Remember that first-time contributors are welcome! 🙌
32+
-->
33+
34+
- [ ] Yes, I have the time and skills to work on this feature.
35+
- [ ] Yes, I have the time, but I would need guidance on how to implement it.
36+
- [ ] No, I don't have the time, although I believe I could do it if I had the time...
37+
- [ ] No, I don't have the time and I wouldn't even know how to start.
38+
39+
<!--
40+
👋 Thank you for taking the time to suggest this feature for Devhub!
41+
Your input helps us improve and expand the tool to better serve the needs of devselopers.
42+
-->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Description
2+
Please provide a summary of the changes made in this pull request. Include any relevant motivation and context for the changes.
3+
4+
Fixes # (issue)
5+
6+
## Type of Change
7+
Please delete options that are not relevant.
8+
- [ ] Bug fix (non-breaking change which fixes an issue)
9+
- [ ] New feature (non-breaking change which adds functionality)
10+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
11+
12+
## How Has This Been Tested?
13+
Manual Testing / Jest Test's
14+
15+
## Checklist
16+
- [ ] My code follows the style guidelines of this project.
17+
- [ ] I have performed a self-review of my code.
18+
- [ ] I have commented my code, particularly in hard-to-understand areas.
19+
- [ ] I have made corresponding changes to the documentation.
20+
- [ ] My changes generate no new warnings.
21+
- [ ] I have added tests that prove my fix is effective or that my feature works.
22+
- [ ] New and existing unit tests pass locally with my changes.
23+
24+
## Additional Notes
25+
Add any other context or information that may be helpful for the reviewers.

CONTRIBUTION.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

INSTALLATION.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

0 commit comments

Comments
 (0)