Contribute

Learn how to contribute to the Next.js MDX Template project

Ways to Contribute

There are several ways you can contribute to the project:

  • Reporting bugs and issues
  • Suggesting new features or improvements
  • Improving documentation
  • Submitting code changes and fixes
  • Adding new components or features
  • Writing tests

Development Setup

Fork and clone the repository

git clone https://github.com/YOUR_USERNAME/mext15.git
cd mext15

Install dependencies

bun install

Create a new branch

git checkout -b feature/your-feature-name

Start the development server

bun run dev

Project Structure

Before making changes, familiarize yourself with the project structure:

  • content/docs/ - MDX documentation files
  • src/app/ - Next.js application routes
  • src/components/ - Reusable React components
  • src/config/ - Site configuration files
  • src/types/ - TypeScript type definitions

Contribution Guidelines

Below are the guidelines for contributing to the project.

Documentation

When adding new features or components:

  1. Update relevant documentation files
  2. Include code examples where appropriate
  3. Add TypeScript types and documentation
  4. Update the table of contents if needed

Pull Requests

  1. Create a new branch for your changes
  2. Make your changes and commit them
  3. Push to your fork and submit a pull request
  4. Ensure your PR description clearly explains the changes
  5. Link any related issues

Getting Help

If you need help or have questions:

  1. Check the existing documentation
  2. Open an issue for questions
  3. Join our community discussions
  4. Reach out to maintainers

Code of Conduct

Please note that this project follows a Code of Conduct. By participating, you are expected to uphold this code.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project.