Skip to content

Commit

Permalink
fix: Updating workflow config
Browse files Browse the repository at this point in the history
Co-authored-by: Deepraj Bera <[email protected]>
  • Loading branch information
Abhishek-Mallick and deepraj21 committed Sep 26, 2024
1 parent 1dab123 commit e91dad7
Show file tree
Hide file tree
Showing 9 changed files with 335 additions and 140 deletions.
74 changes: 74 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
90 changes: 90 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# ✨ Contributing Guide

First off, thank you for considering contributing to DevHub! We appreciate your time and effort in helping make this project better.

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.

## Table of Contents
- [What can I contribute?](#what-can-i-contribute)
- [Before You Contribute](#before-you-contribute)
- [Your First Contribution](#your-first-contribution)
- [Development Workflow](#development-workflow)
- [Cloning the Repository](#cloning-the-repository)
- [Creating a New Branch](#creating-a-new-branch)
- [Making Changes](#making-changes)
- [Submitting a Pull Request](#submitting-a-pull-request)
- [Reporting Bugs](#reporting-bugs)
- [How Do I Submit A Good Bug Report?](#how-do-i-submit-a-good-bug-report)
- [Contribution Guidelines](#contribution-guidelines)
- [Core Work Contributions](#core-work-contributions)
- [Template Contributions](#template-contributions)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## What can I contribute?
There are several ways to contribute to this repository:

1. **Feature Development**: Enhancing the feature functionalities of DevHub, including features related to matchmaking and user interaction.
3. **Bug Fixes**: Identifying and resolving bugs that affect the platform's performance or user experience.

## Before You Contribute
Before starting to contribute, please make sure to:
- **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.
- Review the [**Code of Conduct**](https://github.com/devhub-ai/devhub/blob/main/.github/CODE_OF_CONDUCT.md) and agree to abide by it.

## Your First Contribution
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.

## Development Workflow

### Cloning the Repository
1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Navigate to the project directory in your terminal.

### Creating a New Branch
1. Create a new branch from the `main` branch using `git checkout -b your-branch-name`.
2. Choose a descriptive name for your branch, such as `feat/add-new-feature` or `fix/bug-in-matchmaking`.

### Making Changes
1. Make your changes to the codebase.
2. Ensure your changes follow the project's coding style and conventions.
3. Add or update tests if necessary.

### Submitting a Pull Request
1. Push your branch to your forked repository.
2. Open a pull request from your branch to the `main` branch of the original repository.
3. Fill out the pull request template with relevant information and also mention any issues it resolves (if applicable).
4. Reference any related issues in the pull request description.
5. Wait for maintainers to review your pull request.

## Reporting Bugs

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.

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.

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.

If you cannot find an open or closed issue addressing the problem, **open a new issue**.

Be sure to include:
- A **clear title and description**
- Relevant information
- A **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.

## Contribution Guidelines


1. **Feature Development**: Enhancing the feature functionalities of DevHub, including features related to matchmaking and user interaction.
3. **Bug Fixes**: Identifying and resolving bugs that affect the platform's performance or user experience.

Every template contribution should:
- Include proper documentation that provides an overview of its functionality.
- Contribute relevant examples or templates that enhance user experience.

## Code of Conduct
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).

## License
DevHub is licensed under the [Apache License 2.0](https://github.com/devhub-ai/devhub/blob/main/LICENSE).
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: "🐛 Bug Report"
about: Report a reproducible bug or regression.
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Viable Solution**
If you have a potential solution in mind, please describe it here.

**Additional context**
Add any other context about the problem here.

**Checklist**
- [ ] I have searched for similar issues and couldn't find a resolution.
- [ ] I am willing to work on this issue and submit a pull request.
- [ ] This bug is specific to my OS environment (if yes, please specify above).
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---

name: "✨ Feature Request"
about: Suggest an amazing new idea for this project
title: 'Feature: [Concise Description of the Feature]'
labels: enhancement
assignees: ''

---

## Feature Request

**Is your feature request related to a problem you're trying to solve with Devhub? Please describe.**
<!-- A clear and concise description of what the problem is. Ex. I have an issue when [...] -->

**Describe the solution you'd like**
<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->

**Describe alternatives you've considered**
<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**How would this feature improve Devhub?**
<!-- Explain how the proposed feature would enhance the functionality and user experience of Devhub. -->

**Additional context**
<!-- Add any other context, mockups, or screenshots about the feature request here. -->

## Are you willing to resolve this issue by submitting a Pull Request?

<!--
Remember that first-time contributors are welcome! 🙌
-->

- [ ] Yes, I have the time and skills to work on this feature.
- [ ] Yes, I have the time, but I would need guidance on how to implement it.
- [ ] No, I don't have the time, although I believe I could do it if I had the time...
- [ ] No, I don't have the time and I wouldn't even know how to start.

<!--
👋 Thank you for taking the time to suggest this feature for Devhub!
Your input helps us improve and expand the tool to better serve the needs of devselopers.
-->
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## Description
Please provide a summary of the changes made in this pull request. Include any relevant motivation and context for the changes.

Fixes # (issue)

## Type of Change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## How Has This Been Tested?
Manual Testing / Jest Test's

## Checklist
- [ ] My code follows the style guidelines of this project.
- [ ] I have performed a self-review of my code.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes generate no new warnings.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests pass locally with my changes.

## Additional Notes
Add any other context or information that may be helpful for the reviewers.
41 changes: 0 additions & 41 deletions CONTRIBUTION.md

This file was deleted.

62 changes: 0 additions & 62 deletions INSTALLATION.md

This file was deleted.

Loading

0 comments on commit e91dad7

Please sign in to comment.