Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.8 KB
Raw

Contributing to Pentris

Thank you for your interest in contributing to Pentris! I love it when people have a vision of their own for what I'm working on and I'm more than happy to accept contributions.

Just, make sure your contributions adhere to my contribution policy and workflow, found below.

Workflow

  1. Fork the Repository: Start by forking the repository to your GitHub account.
  2. Create a Branch: Create a new branch from main for your work. Use a descriptive name for your branch (e.g., fix-bug-issue-123 or add-new-feature).
  3. Make Your Changes:
    • Open the JavaScript console for most of your debugging.
    • Use console.log statements to find and troubleshoot errors.
  4. Commit Your Changes: Make clear and concise commit messages.
  5. Push to Your Branch: Push your changes to your branch on GitHub.
  6. Create a Pull Request:
    • Description: Fully describe the problem you found or the feature you want to add.
    • Implementation: Explain how you implemented your changes.
    • Testing: Indicate whether you tested your changes and how.

Pull Request Template

### Description

<!-- Describe the problem or feature in detail -->

### Implementation

<!-- Explain how you implemented your changes -->

### Testing

<!-- Describe any testing you did on your changes and how -->

Additional Tips

  • Keep your changes focused and avoid mixing unrelated tasks in one PR.
  • Ensure your code follows the project's coding style and conventions.
  • Be responsive to feedback during the code review process.

Guidelines for New Developers

Making Changes

  • Open the JavaScript console for debugging.
  • Use console.log statements to track variables and debug issues.

Thank you for contributing to Pentris! If you have any questions, feel free to reach out.