Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 3.52 KB
Raw

Contributing to Eximchain projects

First of all, thank you for considering contributing to our project!

The following is a set of guidelines for contributing to this repository and other projects managed by Eximchain, which are hosted in the Eximchain Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Eximchain Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to hello@eximchain.com.

I just have a question about Eximchain or the project

First check the official Eximchain website and FAQ to see if your question is answered there:

If your question doesn't already have an answer you will get the fastest response by asking in our telegram group! It is actively monitored by Eximchain team members, and you could always get a response from a community member as well.

If you prefer, you may also send us an email, though we strongly encourage using the telegram chat instead.

How can I contrbute to the project?

Reporting Bugs

First, please perform a cursory search to see if the bug has already been reported. If it is, and the issue is still open, please comment on the existing issue instead of opening a new one.

Bugs are tracked as GitHub issues. Once you have determined an issue should be filed, file an issue in the relevant repository. Please keep the following guidelines in mind:

  • Use a clear and descriptive title for the issue
  • Describe the exact steps to reproduce the problem, using as many details as possible.
  • Describe the behavior you observed after following the steps and why it is a problem.
  • Describe the behavior you expected to see instead of the observed behavior.
  • Provide information about the software versions being used. Make sure to include the exact version of the project the issue is being filed for.

Suggesting Improvements

First, please perform a cursory search to see if the improvement has already been suggested. If it is, and the issue is still open, please comment on the existing issue instead of opening a new one.

Improvement suggestions are tracked as GitHub issues. Once you have determined an issue should be filed, file an issue in the relevant repository. Please keep the following guidelines in mind:

  • Use a clear and descriptive title for the issue
  • Provide a step-by-step description of the suggested enhancement, using as many details as possible.
  • Describe the current behavior and what limitations the improvement would address.
  • Describe the behavior that would be observed with the improvement implemented, and why that would be an improvement.
  • If the improvement is significant in scope, submit a pull request to add it to the project roadmap

Styleguides

Git Commit Messages

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