Skip to content

CONTRIBUTING.MD

Latest commit

 

History

History
69 lines (43 loc) · 2.75 KB

CONTRIBUTING.MD

File metadata and controls

69 lines (43 loc) · 2.75 KB

Contributing to Achieve Pull Shark and Pair Extraordinaire Badge with Ease

Thank you for considering contributing to this project! Your contributions are highly appreciated and will help improve the project for everyone.

How to Contribute

1. Reporting Issues

If you encounter any bugs, have suggestions, or want to request a feature, please open an issue in the GitHub Issues section. Provide as much detail as possible, including steps to reproduce the issue if applicable.

2. Submitting Pull Requests

We welcome pull requests for bug fixes, new features, or documentation improvements. To submit a pull request:

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/OCEANOFANYTHING/achieve-pull-shark-and-pair-extraordinaire-badge-with-ease.git
cd achieve-pull-shark-and-pair-extraordinaire-badge-with-ease

  3. Create a Branch: Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make Changes: Implement your changes in the codebase.

  5. Test Your Changes: Ensure your changes work as expected and do not break existing functionality.

  6. Commit Your Changes: Write a clear and concise commit message.

    git add .
git commit -m "Add your commit message here"

  7. Push Your Changes: Push your branch to your forked repository.

    git push origin feature/your-feature-name

  8. Open a Pull Request: Go to the original repository and click "New Pull Request." Follow the template and provide a detailed description of your changes.

3. Code Style Guidelines

  • Follow the existing code style and structure.
  • Use meaningful variable and function names.
  • Write comments to explain complex logic.
  • Ensure your code is clean and free of unnecessary comments or debug statements.

4. Testing

If you add new features or fix bugs, include tests to verify your changes. Ensure all existing tests pass before submitting your pull request.

5. Documentation

If your changes affect the usage of the project, update the relevant documentation in the README.md file or create a new file if necessary.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [INSERT CONTACT METHOD].

License

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

Thank you for your contributions!