Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 2.34 KB

Contributing

First off, Thank you for your interest in contributing to sb-addon-permutation-table We welcome contributions from the community to help improve and enhance the project. Before getting started, please take a moment to review the following guidelines.

Where do I go from here?

If you've noticed a bug or have a feature request, make one! However,Before you jump right in, we recommend checking for duplicate issues and reading our COC

We're always on the lookout for emerging issues. So, please understand that this project is not our full-time job and we cannot devote all of our time to it.

Types of Contributions

You can contribute to our project in the following ways:

  • Reporting bugs and issues.
  • Suggesting new features and enhancements.
  • Improving documentation. (Ex. Translate README.md to another language, Fix Typo...)
  • Writing and enhancing tests.
  • Submitting pull requests for bug fixes, code improvements, or new features.

Development Setup

To set up the development setup, follow these steps:

  1. Fork the repository by clicking the "Fork" button in the GitHub interface.
  2. Clone your forked repository to your local machine: git clone https://github.com/your-username/[sb-addon-permutation-table].git
  3. Install project dependencies: yarn
  4. Start the development server: yarn start
  5. Make your changes and test them locally.

** 23/05/25 : SB7 is having trouble with watch mode. If you want to see change in manager area, you have to rebuild the project. We will fix this problem as soon as possible.

Submitting a Pull Request

When submitting a pull request, please provide the following information:

  • A descriptive title and summary of your changes.
  • Details about the problem your pull request solves or the feature it adds.
  • Any relevant information or context that may help with the review process.

If your pull request contains changes of code, make PR to dev branch. otherwise, make PR to main branch.

Contact

If you have any questions or need further assistance, you can use our Disscusions

License

This project is licensed under the MIT License.