Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

67 lines (40 loc) · 2.48 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project! We appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.

Getting Started

  1. Fork the Repository: Click on the "Fork" button on the top right corner of our repository to create a personal copy.

  2. Clone the Repository: Use the following command to clone your forked repository to your local machine:

    git clone https://github.com/kagawagao/repository-name.git

  3. Create a Branch: Always create a new branch for your feature or bug fix. Use a descriptive name for your branch:

    git checkout -b feature/your-feature-name

Coding Standards

  • Follow the coding style and conventions used in the project. This includes naming conventions, indentation, comments, and file organization.
  • Write clear, self-documenting code where possible.
  • Document your code with comments to explain complex logic.

Writing Tests

  • If applicable, write tests for your contributions. Ensure that tests are passing before submitting a pull request.
  • Add tests in the appropriate test directory and follow existing tests' structure.

Commit Messages

  • Write clear and concise commit messages. Use the following format:

    [type](scope?): Brief description (e.g., fix: correct typo)

  • Types can include: fix, feature, docs, chore, etc.

Submitting Your Contribution

  1. Push Back to Your Fork: After making your changes and committing them, push your branch back to your forked repository:

    git push origin feature/your-feature-name

  2. Create a Pull Request: Go to the original repository and click on the "New Pull Request" button. Follow the prompts to create your pull request.

  3. Reference Issues: If your changes relate to an open issue, reference it in the pull request description (e.g., "Fixes #123").

Reviewing Process

  • Our maintainers will review your pull request. Be open to feedback and ready to make necessary changes.
  • Engage in discussion if needed; clarifications and further enhancements can lead to better outcomes.

Code of Conduct

All contributors are expected to adhere to our Code of Conduct to foster an inclusive and respectful community.

Questions?

If you have any questions or need further clarification, feel free to open an issue or reach out directly.

Thank you for your contributions! Happy coding!