Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

82 lines (60 loc) · 2.68 KB
Raw

Contributing to Svevylon

Thank you for your interest in contributing to Svevylon! We welcome contributions from the community and are excited to work with you. Please read the following guidelines to get started.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand the expectations for all contributors.

How to Contribute

Reporting Issues

If you encounter any bugs, issues, or have feature requests, please open an issue on GitHub. When reporting an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem or suggestion.
  • Steps to reproduce the issue (if applicable).
  • Any relevant screenshots or code snippets.

Submitting Pull Requests

We welcome pull requests for bug fixes, improvements, and new features. To submit a pull request:

  1. Fork the repository.
  2. Create a new branch from main for your changes:
git checkout -b my-feature-branch
  1. Make your changes and commit them with clear and descriptive commit messages.
  2. Push your changes to your forked repository:
git push origin my-feature-branch
  1. Open a pull request on GitHub and provide a detailed description of your changes.

Development Setup

To set up the development environment for Svevylon, follow these steps:

  1. Clone the repository:
git clone https://github.com/SvevylonJS/Svevylon.git
cd Svevylon
  1. Install dependencies:
npm install
  1. Run the development server:
npm run dev
  1. Build the project (optional):
npm run build

Coding Guidelines

To maintain consistency and quality in the codebase, please follow these coding guidelines:

  • Code Style: Follow the existing code style and conventions. Use Prettier and ESLint to format and lint your code.
  • Commit Messages: Write clear and concise commit messages. Use the present tense and include a brief description of the changes.
  • Testing: Ensure that your changes are well-tested. Add new tests if necessary and run the existing test suite to verify that everything works as expected.

License

By contributing to Svevylon, you agree that your contributions will be licensed under the Apache 2.0 License.

Thank you for contributing to Svevylon! We appreciate your time and effort in making this project better.