Skip to content

Latest commit

 

History

History
82 lines (65 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

82 lines (65 loc) · 2.7 KB

Contributing to OpenTag

Thank you for your interest in contributing to OpenTag, our open-source Next.js project! We welcome contributions from everyone. By contributing, you help improve the project and the community around it.

How to Contribute

1. Fork and Clone the Repository

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository: 
    git clone https://github.com/opentag/opentag.github.io.git
cd opentag.github.io

2. Set Up the Project Locally

  1. Install the dependencies: 
    npm i
  2. Start the development server: 
    npm run dev
  3. Open http://localhost:3000 in your browser to see the project running locally.

3. Pick an Issue or Suggest a Feature

  • Browse the issues to find something you'd like to work on.
  • If you want to suggest a new feature, open a new issue to discuss it before submitting a pull request.

4. Create a New Branch

Create a new branch for your work to keep changes isolated:

git checkout -b feature/your-feature-name

5. Write Clean, Documented Code

  • Follow the coding style of the project.
  • Write comments and documentation where necessary.
  • Update tests or add new ones if applicable.

6. Commit Your Changes

Write clear and concise commit messages:

git commit -m "Add feature description"

7. Push Your Changes

Push your branch to your forked repository:

git push origin feature/your-feature-name

8. Submit a Pull Request

  1. Navigate to the original OpenTag repository.
  2. Click "New Pull Request" and choose your branch.
  3. Describe your changes and link to any relevant issues.
  4. Submit the pull request for review.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

Development Guidelines

  • Tech Stack: Next.js, React, and other dependencies listed in package.json.
  • Code Style: Follow the project's ESLint and Prettier configurations.
  • Testing: Ensure that all new code is tested and existing tests pass. Run tests with: 
    npm test

Issues and Bugs

If you find a bug:

  1. Check the issues to see if it has already been reported.
  2. If not, open a new issue with detailed steps to reproduce the problem.

Suggestions

We welcome all suggestions to improve OpenTag. Please open a new issue to discuss your ideas!

Questions

If you have any questions, feel free to open an issue or reach out to the maintainers. We’re here to help!

Thank you for contributing to OpenTag! Together, we can build something amazing.