Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (26 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.56 KB

Contributing to DevYork

Thank you for your interest in contributing to DevYork! We welcome contributions from the community to make this platform better for everyone.

Getting Started

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page.
  2. Clone your Fork: git clone https://github.com/thearkxd/devyork-website.git
  3. Create a Branch: git checkout -b feature/your-feature-name or git checkout -b fix/your-bug-fix

Development Environment

Please refer to the README.md for detailed instructions on setting up the backend and frontend.

Coding Standards

  • Code Style: We use Prettier for code formatting. Please ensure your code is formatted before committing.
  • Commits: Write clear and concise commit messages. Use the conventional commits format if possible (e.g., feat: add new rating system, fix: resolve login bug).
  • Comments: Add comments to explain complex logic.

Pull Request Process

  1. Ensure your code builds and runs locally without errors.
  2. Run backend tests: cd backend && yarn test
  3. Update documentation if you change any logic that affects the user or developer experience.
  4. Submit a Pull Request (PR) to the main branch.
  5. Describe your changes in detail in the PR description.

Reporting Bugs

If you find a bug, please open an issue with the following details:

  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)

License

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