Skip to content

Latest commit

 

History

History
99 lines (73 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

99 lines (73 loc) · 3.92 KB
Raw

Contributing to the Redot Game Engine Website

Thank you for your interest in contributing to the "Redot" Game Engine Website! 🎉
This project is an open-source initiative, and we welcome contributions that help improve the website's development in Vue, JavaScript, CSS, TypeScript, and SCSS.

By contributing, you help create a better user experience for the Redot community.

How to Contribute

We value any kind of contribution, including (but not limited to):

  • Reporting bugs 🐛
  • Suggesting new features or improvements 🚀
  • Fixing bugs 🛠️
  • Improving documentation 📚
  • Refactoring or optimizing code ⚡
  • Writing tests 🧪

Getting Started

  1. Fork the repository:
    You will need to fork this repository to your own GitHub account, then clone it to your local machine.

  2. Install dependencies:
    After cloning the repository, navigate to the project folder and run:

    # npm
npm install

  3. Start the development server: Run the following command to start a local development environment:

    # npm
npm run dev

    This will start a server at http://localhost:3000, where you can preview your changes live.

  4. Create a new branch: When making changes, create a new branch to work on your contribution:

    git checkout -b your-feature-branch

  5. Make your changes: Edit the code, write tests if necessary, and ensure the project is still functioning as expected.

  6. Run linting and tests: To ensure that the code meets our style and quality standards, please run:

    npm run lint
npm test

  7. Submit a pull request: Once you're satisfied with your changes, push your branch to your fork and submit a pull request (PR) to the main repository. Please include a clear title and description of your changes.

Contribution Guidelines

Please follow these guidelines to ensure your contribution is well-received:

Code Style

  • Follow the existing code style used in the project.
  • Use TypeScript when writing new functionality or updating code where it is already used.
  • SCSS is used for styling, and we prefer modular, reusable components.
  • Comment your code where necessary, especially for complex logic or design choices.

Commit Messages

  • Use clear and concise commit messages.
  • Prefix your commit messages with relevant tags, such as [Fix], [Feature], [Refactor], etc.
    example: [Feature] Add new navbar component for responsive design

Pull Requests

  • Ensure your pull request is based on the main branch.
  • Include a detailed explanation of the changes you have made.
  • Reference related issues if applicable, e.g., Fixes #123.
  • Be open to feedback! We review all PRs to maintain the project's quality.

Reporting Bugs

To report a bug:

  1. Check if the issue is already reported: Before opening a new issue, please ensure that it hasn't been already reported in the issue tracker.

  2. Open a new issue: If the issue is new, please include clear, step-by-step details to reproduce the bug and any relevant screenshots or logs.

Communication and Support

If you need help or have questions about contributing, please join our community on Discord, where our maintainers and contributors are happy to assist. 🤝

Feeling Misjudged?

If you ever feel that your contributions or feedback were misjudged or not treated fairly, you can report or appeal on our Discord. We are committed to ensuring that the development process is fair, respectful, and inclusive for everyone.

Code of Conduct

Please review our Code of Conduct before contributing. We are committed to maintaining a welcoming and friendly community.

License

By contributing, you agree that your contributions will be licensed under the MIT License.