Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

88 lines (55 loc) · 3.57 KB
Raw

Getting Started

Prerequisites

Before you start contributing, ensure you have met the following requirements:

  • A GitHub account.
  • Familiarity with Git and GitHub.
  • Knowledge of the solidity, hardhat, javascript, typescript and tools used in the project.
  • Understanding of the project's goals and guidelines.

Setting Up the Project

  1. Fork the repository on GitHub.

    • Go to the main repository on GitHub: Project Name
    • Click the "Fork" button in the upper right corner to create a copy of the repository in your GitHub account.

  2. Clone the forked repository to your local machine.

git clone https://github.com/dev-futurify/cryptocities.git
cd cryptocities
  1. Create a new branch for your contributions.
git checkout -b your-branch-name
  1. Make your changes, commit them, and push to your forked repository.
git add .
git commit -m "Description of your changes"
git push origin your-branch-name

  1. Go to the Pull Requests tab of the repository.

    • Click on the "New Pull Request" button.
    • Select the base repository (main repository) and the base branch (main).
    • Select your forked repository and your branch as the compare branch.
    • Provide a descriptive title and a detailed description of your changes.

  2. Wait for review and feedback from project maintainers.

    • Project maintainers will review your pull request, provide feedback, and collaborate with you to ensure the quality of your contribution.

Making Contributions

We welcome all contributions that align with the goals of our project. Here's how you can make meaningful contributions:

Coding Guidelines

Before submitting your code changes, ensure that they follow our coding guidelines. These guidelines maintain consistency and make the codebase more readable for everyone.

Testing

Write tests for the code you contribute. Tests help ensure that your changes are functioning correctly and prevent regressions in the future.

Documentation

Contribute to the project's documentation. This includes updating existing documentation and adding new sections where necessary. Clear documentation is vital for newcomers to understand and use the project effectively.

Reporting Issues

If you encounter a bug, have a question, or want to suggest an improvement, check our Issue Tracker before creating a new issue. It's possible that someone else has already reported the same issue or that the question has been answered.

Pull Request Process

  1. Make sure you have followed the Getting Started guide and have pushed your changes to your forked repository.

  2. Create a pull request (PR) from your forked repository to the main repository. Provide a descriptive title and a detailed description of your changes.

  3. Your PR will be reviewed by project maintainers. They may provide feedback or request changes. Collaboration is key to improving the quality of your contribution.

  4. Once your PR has been approved and all feedback has been addressed, it will be merged into the main repository.

  5. Celebrate! 🎉 You've successfully contributed to our project!

Code of Conduct

When contributing, please adhere to our Code of Conduct. We expect all contributors to follow these guidelines to create a respectful and inclusive environment for everyone.

Thank You

Thank you for your interest in contributing to our project! Your contributions help make our project better and more useful for the community.

If you have any questions, feel free to reach out to us in the Discussion section.

Happy contributing!