Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 3.45 KB

Contributing to Admin Toolkit

Thank you for your interest in contributing to the Admin Toolkit. 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. We expect all contributors to maintain a respectful and inclusive environment.

Reporting Issues

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

  1. Go to the 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 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 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.

  4. Commit your changes using a descriptive commit message that follows defined Conventional Commits 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.