Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (59 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

73 lines (59 loc) · 2.93 KB

Here's a CONTRIBUTING.md template for your cryptocurrency investigation backend project on GitHub:

Contributing to Onchain Analysis Cryptocurrency Investigation Backend

How to Contribute

1. Reporting Issues

  • Search existing issues to ensure your issue hasn't already been reported.
  • If it’s a new issue, open a new issue and provide a clear and descriptive title.
  • Include steps to reproduce the issue, expected behavior, and any relevant error messages or logs.

2. Suggesting Enhancements

  • Search existing issues to avoid duplicate suggestions.
  • Open a new issue with the label enhancement and clearly describe the feature you’re suggesting, along with any potential use cases.

3. Submitting a Pull Request

  • Fork the repository and clone your forked copy.
  • Create a new branch based on the feature or fix you're working on. 
    git checkout -b feature/your-feature-name
  • Make sure to follow the project's coding style and conventions.
  • Commit your changes with a meaningful commit message. 
    git commit -m "Add meaningful commit message here"
  • Push your branch to your forked repository: 
    git push origin feature/your-feature-name
  • Open a pull request to the main branch and provide a description of your changes. Include links to any related issues.

4. Code Style

  • Follow the existing code style and conventions. This project uses [standard coding guidelines] (e.g., PEP8 for Python).
  • Ensure your code is well-documented, with comments explaining complex logic where necessary.

Running the Project Locally

To set up the project on your local machine:

  1. Clone the repository: 
    git clone https://github.com/pramaths/onchainanalysis.git
cd onchainanalysis
  2. Install dependencies: 
    # npm install
  3. Set up your environment variables as defined in .env.example.
  4. Run the development server: 
    # nodemon index.js / node indx.js

Testing

  • Ensure any new features or changes include appropriate test cases.
  • Run all tests to verify that existing features aren’t broken by your changes. 
    # node test_file_name.js

Code of Conduct

We follow a code of conduct to ensure a welcoming and inclusive environment for everyone. Please read our Code of Conduct before contributing.

Getting Help

If you have questions, feel free to reach out by opening an issue or discussing on our project’s community channels (add any relevant links).

Thank you for contributing to Onchain Analysis Cryptocurrency Investigation Backend! 🚀

Replace "https://github.com/your-repo" with your actual GitHub repository link. If you have any specific setup instructions for dependencies or environment variables, add those details as well. Let me know if you'd like more customization!