Skip to content

Commit

Permalink
feat: add guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
mostafizurhimself committed Jan 7, 2024
1 parent e6d35e4 commit 6cfcdd3
Show file tree
Hide file tree
Showing 5 changed files with 167 additions and 6 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
---

### 📝 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 -->

<!-- We can't provide support without a reproduction, and your issue will be closed with no comment if this is not provided. -->

### 🤔 Expected behavior

<!-- A clear and concise description of what you expected to happen. -->

### 🖼️ Screenshots

<!-- If applicable, add screenshots to help explain your problem. -->

### 💻 Browser Information

<!-- Please complete the following information:
- Browser [e.g. Chrome, Firefox, Edge]
- Version [e.g. 92.0.4515.107] -->

### 📝 Additional context

<!-- Add any other context about the problem here. -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 🚀 Feature request
about: Suggest an idea for this project
---

### 🤔 Is your feature request related to a problem? Please describe.

<!-- A clear and concise description of what the problem is. For example: "I'm always frustrated when..." -->

### 💡 Describe the solution you'd like

<!-- A clear and concise description of what you want to happen. -->

### 🔄 Describe alternatives you've considered

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

### 📚 Additional context

<!-- Add any other context or screenshots about the feature request here. -->
43 changes: 43 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Code of Conduct

As contributors and maintainers of the <b>Admin Tookit</b>, we are dedicated to fostering an open and inclusive community. We value the participation of everyone and strive to create a positive and respectful environment for all individuals, regardless of their background or identity. We expect all contributors and users to adhere to this Code of Conduct in all project spaces, including but not limited to GitHub repositories, issue trackers, and communication channels.

## Our Standards

When participating in the <b>Admin Tookit</b> community, we ask that you:

1. **Be Respectful:** Treat all individuals with respect and kindness. Respect differences in opinion, viewpoints, and experiences. Harassment, discrimination, or any form of abusive behavior will not be tolerated.

2. **Be Inclusive:** Embrace diversity and inclusivity. We welcome contributions from people of all backgrounds and identities. Be considerate of how your words and actions may affect others in the community.

3. **Be Collaborative:** Work together with other community members in a collaborative and constructive manner. Value the contributions of others and give credit where it's due.

4. **Be Patient:** Recognize that not everyone may have the same level of experience or knowledge. Be patient and supportive in helping others grow and learn.

5. **Be Mindful:** Think before you speak or act. Consider the potential consequences of your actions and ensure they align with the values of the community.

## Unacceptable Behavior

The following behaviors are considered unacceptable within the <b>Admin Toolkit</b> community:

1. **Harassment:** Any form of harassment, including but not limited to offensive comments, insults, or unwelcome advances, will not be tolerated.

2. **Discrimination:** Discrimination based on race, ethnicity, gender, sexual orientation, religion, disability, or any other personal characteristic is unacceptable.

3. **Intimidation:** Intimidating, threatening, or bullying behavior directed at others is not permitted.

4. **Hate Speech:** Hate speech or any language that promotes hatred or violence against individuals or groups is strictly prohibited.

5. **Trolling and Disruptive Behavior:** Deliberately disruptive, disrespectful, or inflammatory behavior is not acceptable.

## Reporting and Enforcement

If you witness or experience any behavior that violates this Code of Conduct, please report it promptly to the project maintainers at `[email protected]`. All reports will be treated with strict confidentiality and will be reviewed and addressed accordingly. In order to maintain a safe and welcoming community, appropriate actions will be taken against individuals found to be in violation of this Code of Conduct. These actions may include warnings, temporary or permanent bans, and other appropriate measures.

## Attribution

This Code of Conduct is inspired by the Contributor Covenant version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

## Scope

This Code of Conduct applies to all project spaces and interactions related to the <b>Admin Toolkit</b>, both online and offline. It also applies to all individuals involved in the project, including but not limited to contributors, maintainers, users, and visitors.
67 changes: 67 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Contributing to Admin Toolkit

Thank you for your interest in contributing to the <b>Admin Toolkit</b>. Whether you want to report issues, suggest new features, or contribute code changes, your participation is highly appreciated. Please take a moment to review this guide before getting started.

## Code of Conduct

Before contributing, please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to maintain a respectful and inclusive environment.

## Reporting Issues

If you encounter bugs, issues, or unexpected behavior in <b>Admin Toolkit</b>, please check the existing issues on GitHub to see if it's already reported. To submit a new issue:

1. Go to the [Issues](https://github.com/mostafizurhimself/admintoolkit-html/issues) section.
2. Click on the "New Issue" button.
3. Select the appropriate issue template (bug report, feature request, etc.).
4. Provide clear and concise details about the problem or suggestion.

We will review the issue and respond promptly. Please be patient and offer additional information if required.

## Feature Requests

We encourage you to share ideas and request new features for the Admin Toolkit:

1. Go to the [Issues](https://github.com/mostafizurhimself/admintoolkit-html/issues) section.
2. Click on the "New Issue" button.
3. Choose the "Feature Request" template.
4. Describe the feature you propose, offering as much context as possible.

Upon review, if your feature aligns with the project goals, it may be added to our development roadmap.

## Development Setup

To set up the development environment for the Admin Toolkit:

1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine.
3. Install dependencies by running `yarn install` in the project root folder.
4. Start the development server by running `yarn dev`.
5. Make your changes and commit them to your forked repository.

## Creating Pull Requests

Before you submit your pull request consider the following guidelines:

1. Search [GitHub](https://github.com/mostafizurhimself/admintoolkit-html/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.
2. Create a new branch based on the `main` branch with a descriptive name (e.g., `feature/new-feature` or `bugfix/issue-123`).
3. Implement your changes, ensuring adherence to the [coding guidelines](#coding-guidelines).
4. Commit your changes using a descriptive commit message that follows defined [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

5. Push your branch to your forked repository on GitHub.
6. Open a pull request (PR) against the `main` branch of the original repository.
7. Provide a detailed description of your changes and the problem they address in the PR description.

Our team will review your PR, provide feedback if needed, and merge it once it meets our standards.

## Coding Guidelines

To maintain code consistency and readability, follow these guidelines:

- Use meaningful variable and function names.
- Adhere to the existing coding style, including indentation and formatting.
- Add comments, especially in complex sections, to enhance understanding.
- Write clear and concise commit messages, explaining each commit's purpose.

## License

By contributing to the Admin Toolkit, you agree that your contributions will be licensed under the [MIT License](LICENSE).
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,7 @@ yarn start

## 📌 Contribution

1. Fork the repository
2. Clone the repository
3. Create a new branch `git checkout -b new-branch`
4. Make changes
5. Commit and push the changes
6. Create a pull request
If you're interested in contributing to Admin Toolkit, Please read our [contributing docs](CONTRIBUTING.md) before submitting a pull request.

## 📌 License

Expand Down

0 comments on commit 6cfcdd3

Please sign in to comment.