Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
145 lines (102 loc) · 5.36 KB

CONTRIBUTING.md

File metadata and controls

145 lines (102 loc) · 5.36 KB

Contributing to URL Note Taker

日本語 | English

日本語

プロジェクトへの貢献を歓迎します！

URL Note Taker プロジェクトへの貢献にご関心をお寄せいただき、ありがとうございます。このドキュメントでは、プロジェクトに貢献する方法について説明します。

貢献の方法

🐛 バグ報告

  • Issues でバグを報告してください
  • バグの再現手順、期待される動作、実際の動作を明記してください
  • 可能であれば、ブラウザとユーザースクリプトマネージャーの情報も含めてください

💡 機能提案

  • Discussions で新機能のアイデアを提案してください
  • 機能の目的と具体的な使用例を説明してください

🔧 プルリクエスト

  1. リポジトリをフォークしてください
  2. 機能ブランチを作成してください (git checkout -b feature/amazing-feature)
  3. 変更をコミットしてください (git commit -m 'Add amazing feature')
  4. ブランチにプッシュしてください (git push origin feature/amazing-feature)
  5. プルリクエストを作成してください

開発ガイドライン

コードスタイル

  • JavaScript ES6+ を使用してください
  • 既存のコードスタイルに合わせてください
  • 意味のある変数名・関数名を使用してください

テスト

  • 変更により既存の機能が破綻しないことを確認してください
  • 複数のブラウザでテストしてください

コミットメッセージ

  • 英語で記述してください
  • 変更内容を簡潔に説明してください
  • feat:, fix:, docs:, style:, refactor: などのプレフィックスを使用してください

貢献者ライセンス同意

重要: このプロジェクトに貢献することにより、以下に同意したものとみなされます：

  1. 著作権: あなたの貢献に対する著作権を保持しますが、プロジェクトでの使用を許可します
  2. ライセンス: あなたの貢献は MIT License の下で配布されます
  3. 将来のライセンス変更: プロジェクト維持者が将来的にライセンスを変更する可能性があることに同意します
  4. オリジナル作品: あなたの貢献がオリジナル作品であり、第三者の権利を侵害しないことを保証します

行動規範

尊重と包容性

  • すべての参加者を尊重してください
  • 建設的なフィードバックを提供してください
  • 多様な意見や経験を歓迎してください

プロフェッショナリズム

  • 技術的な議論に集中してください
  • 個人攻撃や侮辱的な言動は避けてください
  • 問題解決に向けて協力的に取り組んでください

質問やサポート

  • 一般的な質問: Discussions
  • バグ報告: Issues
  • セキュリティ問題: メールで直接連絡してください

English

Welcome Contributors!

Thank you for your interest in contributing to the URL Note Taker project. This document explains how you can contribute to the project.

How to Contribute

🐛 Bug Reports

  • Report bugs via Issues
  • Please include reproduction steps, expected behavior, and actual behavior
  • If possible, include browser and userscript manager information

💡 Feature Requests

  • Propose new feature ideas in Discussions
  • Explain the purpose of the feature and provide specific use cases

🔧 Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Create a Pull Request

Development Guidelines

Code Style

  • Use JavaScript ES6+
  • Follow existing code style conventions
  • Use meaningful variable and function names

Testing

  • Ensure changes don't break existing functionality
  • Test across multiple browsers

Commit Messages

  • Write in English
  • Provide clear, concise descriptions of changes
  • Use prefixes like feat:, fix:, docs:, style:, refactor:

Contributor License Agreement

Important: By contributing to this project, you agree to the following:

  1. Copyright: You retain copyright to your contributions but grant permission for use in this project
  2. License: Your contributions will be distributed under the MIT License
  3. Future License Changes: You consent to potential future license changes by project maintainers
  4. Original Work: You warrant that your contributions are original and don't infringe third-party rights

Code of Conduct

Respect and Inclusivity

  • Treat all participants with respect
  • Provide constructive feedback
  • Welcome diverse opinions and experiences

Professionalism

  • Focus on technical discussions
  • Avoid personal attacks or derogatory language
  • Work collaboratively toward problem resolution

Questions and Support

  • General Questions: Discussions
  • Bug Reports: Issues
  • Security Issues: Contact directly via email

Thank you for contributing to URL Note Taker! 🎉