Skip to content

Latest commit

 

History

History
38 lines (21 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

38 lines (21 loc) · 2.19 KB
Raw

Contributing to CircuitVerse

  • Thanks for checking out our guide. We'll be glad to hear from you.
  • Interested in making a contribution? Read on!

How to Contribute

When you are ready to start work on a issue:

  • Let us know by leaving a comment on the issue. (Also let us know later if you are no longer working on it.)

  • Once you are assigned the issue (or you have claimed the issue) only then proceed to making the Pull Request. This will help avoid multiple PRs pertaining to the same issue.

If you don't see your idea listed, do one of the following:

  • If your contribution is minor, such as a typo fix, open a pull request.
  • If your contribution is major, such as a new feature/enhancement, start by opening an issue first. That way, other people can be also involved in the discussion before you do any work.

Pull Request Process

  1. Create a branch. For example, if you are going to work on issue number #44 (which is, say, a new feature for ‘forgot password’ management):

     git checkout -b forgot-password#44

    This both creates and checks out that branch in one command.
    The feature name should provide a (short) description of the issue.

  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

  3. Develop the feature and push it to your local repo.

  4. Create Pull Request (PR). Make sure to comment the issue that your PR is supposed to solve.

Community

Discussions about the CircuitVerse take place on the repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations. There is also a chat room for regular updates.

We encourage people to talk on public platforms for maximum participation. Whenever possible, avoid taking conversations to private channels. Keeping communication public means everybody can benefit and learn from the conversation.