Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (33 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

57 lines (33 loc) · 2.58 KB

Contributing to Passage Indexer

First off, thank you for considering contributing to Passage. It's people like you that make Passage the experience it is.

Open Development

All work on Passage happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

Branch Organization

We will do our best to keep the master branch in good shape, with tests passing at all times. If you're making a big change, please create a new branch and submit your pull request from there.

Bugs

We are using GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Feature Requests

We're always open to new ideas to make Passage better. If you have an idea or a feature request, open an issue to discuss it, or directly submit a pull request.

Getting Started

Before you begin, make sure you have a GitHub account and that you are familiar with basic GitHub workflows.

  1. Fork the repository on GitHub
  2. Clone your fork to your local machine: git clone https://github.com/Passage-Chain/indexer.git
  3. Create a branch for your changes: git checkout -b my-feature-branch
  4. Make your changes, committing them with clear, descriptive messages
  5. Push your changes to your fork: git push origin my-feature-branch
  6. Open a pull request against the original repository

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Coding Standards

Please ensure your code adheres to the project's coding standards. (You might specify a link to coding standards documentation or a file in the repository.)

Tests

Where possible, please add tests to cover the new functionality or bug fixes you are contributing. This helps ensure the quality and longevity of the project.

Community

Discussions about OurProject take place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations.

In addition, there may be more specific channels for discussion, such as a Discord server or Slack channel - please check the README for more details.

Wherever possible, we try to keep discussions open for the public to participate in.

Thank you for your contributions to Passage!