Skip to content

Latest commit

 

History

History
70 lines (53 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

70 lines (53 loc) · 2.85 KB
Raw

Contributing to Ananke

Contributions are welcome and can be represented in many different ways as noted below. Help is greatly appreciated and credit will always be given.

Types of Contributions

Reporting Bugs

Report bugs on the issues page. With your bug report, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting the issue.
  • Detailed steps to reproduce the bug.

Fixing bugs

Find bugs at the issues page. Anything tagged with "bug" is open to be fixed. With your fix, please include:

  • The issue number
  • A detailed commit message

Implementing Features

Find features at the issues page. Anything tagged with "feature" is open to be implemented. With your feature, please include:

  • The issue number
  • A detailed commit message

Writing Documentation

Ananke can always use documentation (more documentation is always better!). Please document your features or usage as part of the official docs, in docstrings, in blog posts, articles, or wherever you see fit.

Submitting Feedback

File an issue at the issues page. If you are proposing a feature:

  • Explain how it would work in detail
  • Keep the scope as narrow as possible to make it easier to implement

Workflow

  1. Create a branch directly in this repo or a fork (if you don't have push access). Please name branches within this repository feature/<description> or fix/description. For example, something like feature/upgrade_agent_0.2.3-70.

  2. Create an issue or open a pull request (PR). If you aren't sure your PR will solve the issue or may be controversial, we're okay with you opening an issue separately and linking to it in your PR. That way, if the PR is not accepted, the issue will remain and be tracked.

  3. Clone the fork/branch locally.

  4. Close (and reference) issues by the closes #XXX or fixes #XXX notation in the commit message. Please use a descriptive, useful commit message that could be used to understand why a particular change was made.

  5. Keep pushing commits to the initial branch using --amend/--rebase as necessary. Don't mix unrelated issues in a single branch.

  6. Clean up the branch (rebase with master to synchronize, squash, edit commits, test, etc.) to prepare for it to be merged.

  7. If you didn't open a pull request already, do so now.

  8. After reviewing your commits for documentation, passed continuous integration (CI) tests, version bumps, changelogs, and good, descriptive commit messages, a project maintainer can merge your request.

  9. Create/update the changelog if necessary.