Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 2.39 KB

Contributing to DeployContracts.io

Thank you for considering contributing to DeployContracts.io! We appreciate your support and effort to make this project better. Here are some guidelines to help you get started.

How to Contribute

Reporting Issues

If you encounter any issues or bugs, please report them by creating a new issue in the GitHub Issues section. Make sure to include the following information:

  • A clear and descriptive title.
  • A detailed description of the issue.
  • Steps to reproduce the issue.
  • Any relevant logs or screenshots.

Suggesting Enhancements

If you have ideas for new features or improvements, please open a new issue in the GitHub Issues section and provide the following details:

  • A clear and descriptive title.
  • A detailed description of the proposed enhancement.
  • Any relevant examples or use cases.

Submitting Pull Requests

If you want to contribute code, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/tukwan/deploycontracts.io.git

  3. Create a new branch for your feature or bugfix:

    git checkout -b feature-or-bugfix-name

  4. Make your changes in the new branch.

  5. Commit your changes with a descriptive commit message:

    git commit -m "Description of the changes made"

  6. Push your changes to your forked repository:

    git push origin feature-or-bugfix-name

  7. Create a pull request to the main repository:

    • Go to the main repository on GitHub.
    • Click on the "New Pull Request" button.
    • Select your branch from the "compare" dropdown.
    • Provide a descriptive title and detailed description for your pull request.
    • Submit the pull request.

Code Style

Please ensure that your code adheres to the following guidelines:

  • Follow the existing code style and conventions.
  • Write clear and concise commit messages.
  • Include comments and documentation where necessary.

Testing

Ensure that your changes do not break existing functionality by running tests. If you add new features, include corresponding tests. Run the following command to execute the tests:

npm test