Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

87 lines (67 loc) · 3.54 KB

Contributing to Cryptack

Thank you for considering contributing to Cryptack! We appreciate your time and effort in helping improve this project. To ensure that your contributions are in line with the project's goals and standards, please follow the guidelines outlined below.

Getting Started

1. Fork the Repository

Before making any changes, fork the repository to your GitHub account.

2. Clone the Repository

Clone the forked repository to your local machine:

git clone https://github.com/yourusername/cryptotracker.git
cd cryptotracker

3. Create a New Branch

Create a new branch for your feature, bug fix, or other contributions:

git checkout -b your-branch-name

4. Install Dependencies

Ensure you have all the necessary dependencies installed:

npm install

Making Changes

Code Style and Guidelines

  • Follow the existing code style in the project. If you’re adding new code, ensure it is well-documented and adheres to the project's conventions.
  • Keep your code clean, concise, and well-commented.
  • Use meaningful commit messages that explain what your changes do.

Adding New Features or Enhancements

  • Before starting on a major feature, open an issue to discuss your idea. This helps avoid overlapping work and ensures your contribution aligns with the project's direction.
  • If you're adding new functionality, include tests to cover your changes.

Fixing Bugs

  • When fixing a bug, describe the issue clearly in your pull request. Reference any related issues in the repository.
  • Ensure that the fix is well-tested and does not break existing functionality.

Writing Documentation

  • If your changes affect the public API, update the relevant documentation in the README.md and any other applicable files.
  • Ensure that all new features and functions are documented.

Testing

Please run the following command to ensure that all tests pass:

npm test

Making Changes

If you add new functionality, write corresponding tests and ensure they pass. We aim for comprehensive test coverage to maintain code quality.

Submitting Changes

1. Commit Your Changes

Once your changes are ready, commit them with a clear and descriptive message:

git commit -m "Your descriptive commit message"

2. Push to Your Fork

Push your changes to your forked repository:

git push origin your-branch-name

3. Open a Pull Request

  • Go to the original repository and open a Pull Request (PR) against the main branch.
  • In your PR description, explain the changes you've made, why you've made them, and any additional context.
  • Ensure that your PR is linked to any relevant issues.

Code Review

  • Your PR will be reviewed by one or more maintainers. Please be patient as it may take some time to get feedback.
  • You may be asked to make additional changes or improvements based on the review.
  • Once your PR is approved, it will be merged into the main branch.

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue. Be sure to provide as much detail as possible, including steps to reproduce the problem.

Community

We value respectful and constructive communication. When interacting with others in the project, please follow our Code of Conduct.

Thank You!

Your contributions make this project better for everyone. Thank you for your time and effort in helping make Cryptack a valuable tool for the community!