Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

80 lines (50 loc) · 2.9 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to the Gtihub-solana auto-dispenser project! We welcome contributions from the community to help make this project better. Before you start, please take a moment to review these guidelines.

Getting Started

  1. Fork the repository to your own GitHub account.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/<username>/github-sol-auto-dispenser.git

  3. Install the project dependencies:

    cd gtihub-solana-auto-dispenser
npm install

  4. Create a new branch for your contribution:

    git checkout -b feature/your-feature-name

  5. Make your changes and commit them with clear and concise commit messages:

    git commit -s -m "Add feature/fix: description of your changes"

  6. Push your changes to your fork:

    git push origin feature/your-feature-name

  7. Create a pull request (PR) to the main branch of the original repository.

Guidelines for Contributions

  • Please ensure that your code adheres to the project's coding standards and style.
  • Write clear and concise code with meaningful comments when necessary.
  • Document any new functionality or changes you introduce.
  • Test your changes thoroughly before submitting a PR to ensure they do not introduce bugs.

Reporting Bugs

If you encounter a bug in the project, please follow these steps to report it:

  1. Check if the bug has already been reported in the Issues section of the repository. If it hasn't, create a new issue.
  2. Provide a clear and detailed description of the bug, including steps to reproduce it.
  3. Include any relevant error messages or stack traces.
  4. If possible, provide a fix or suggest a solution to the issue.

Feature Requests

If you have an idea for a new feature or improvement, please follow these steps:

  1. Check if the feature or improvement has already been requested in the Issues section of the repository. If it hasn't, create a new issue.
  2. Describe the new feature or improvement in detail, including why it's needed and how it should work.

Code Review Process

All contributions will be reviewed by project maintainers. Please be patient and be prepared to make changes to your code based on their feedback.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please report any unacceptable behavior to [email protected] .

Thank You

We appreciate your contributions to the our project. Your help makes a difference in our efforts to the opensource world. Thank you for being a part of this community!

Feel free to customize the above template to match your project's specific needs and requirements.

Thanks for Contributing! 🎉