Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 2.19 KB
Raw

Contributing to ASALI

Thank you for contributing to ASALI! We appreciate your help as this is largely as volunteer effort!

How to contribute

Reporting Bugs

Before creating a bug report, please do at least a cursory check that the bug has not already been reported. If it has, add a comment to the existing issue instead of opening a new one.

Submitting a Bug Report

Bugs are tracked as GitHub issues. After you've determined you've found a new bug, please open a new issue.

Explain the problem and include additional details to help maintainers reproduce the problem. Here are some items that will make it easier to track down the source of the problem.

  • Use a clear and descriptive title for the issue that identifies the problem.
  • Describe the exact steps that reproduce the problem.
  • Describe the behavior you are seeing after these steps.
  • Describe the behavior you expect to see after these steps.
  • Send at [email protected] all the files required to repreduce the bug.

Additionally, the answers to the following questions about your run environment will be helpful.

  • What is he name and version of you OS?
  • What compiler are you using?
  • How did you build ASALI (if using the development version)?

Submitting Changes

Changes to ASALI should be submitted as pull requests.

  • Fork the repository into your GitHub account.
  • Clone the forked repository to local machine, make the changes.
  • Commit and push the changes to GitHub.
  • Open a new GitHub pull request.
  • Ensure the pull request description clearly describes the problem and solution. Include the relevant issue number.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Reference issues and pull requests liberally

Pull Request Messages

  • Rename the pull request and provide a comment that synthesizes what the pull request changes or adds. This helps us synthesize what changes have occured between ASALI releases.