# Contributing to Trime We would love for you to contribute to Trime and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: - [Code of Conduct](#coc) - [Question or Problem?](#question) - [Issues and Bugs](#issue) - [Feature Requests](#feature) - [Submission Guidelines](#submit) - [Coding Rules](#rules) - [Commit Message Guidelines](#commit) ## Code of Conduct Help us keep Trime open and inclusive. Please read and follow our [Code of Conduct][coc]. ## Got a Question or Problem? Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. Instead, we recommend using QQ or Tieba. To save your and our time, we will systematically close all issues that are requests for general support and redirect people to community. ## Found a Bug? If you find a bug in the source code, you can help us by [submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can [submit a Pull Request](#submit-pr) with a fix. ## Missing a Feature? You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub Repository. If you would like to *implement* a new feature, please consider the size of the change in order to determine the right steps to proceed: * For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. **Note**: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature. * **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). ## Submission Guidelines ### Submitting an Issue Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions. A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it. Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced. You can file new issues by selecting from our [new issue templates](https://github.com/osfans/trime/issues/new/choose) and filling out the issue template. ### Submitting a Pull Request (PR) Before you submit your Pull Request (PR) consider the following guidelines: 1. Search [GitHub](https://github.com/osfans/trime/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. 2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work. 3. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the osfans/trime repo. 4. In your forked repository, make your changes in a new git branch: ```shell git checkout -b my-fix-branch master ``` 5. Create your patch, **including appropriate test cases**. 6. Follow our [Coding Rules](#rules). 7. Run the full test suite, and ensure that all tests pass. 8. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages. ```shell git commit --all ``` Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. 9. Push your branch to GitHub: ```shell git push origin my-fix-branch ``` 10. In GitHub, send a pull request to `trime:develop`. ### Reviewing a Pull Request The Trime team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the [Trime code of conduct][coc] and applies within or outside of Trime managed channels. #### Addressing review feedback If we ask for changes via code reviews then: 1. Make the required updates to the code. 2. Re-run the Trime test suites to ensure tests are still passing. 3. Create a fixup commit and push to your GitHub repository (this will update your Pull Request): ```shell git commit --all --fixup HEAD git push ``` That's it! Thank you for your contribution! ##### Updating the commit message A reviewer might often suggest changes to a commit message (for example, to add more context for a change or adhere to our [commit message guidelines](#commit)). In order to update the commit message of the last commit on your branch: 1. Check out your branch: ```shell git checkout my-fix-branch ``` 2. Amend the last commit and modify the commit message: ```shell git commit --amend ``` 3. Push to your GitHub repository: ```shell git push --force-with-lease ``` > NOTE:
> If you need to update the commit message of an earlier commit, you can use `git rebase` in interactive mode. > See the [git docs](https://git-scm.com/docs/git-rebase#_interactive_mode) for more details. #### After your pull request is merged After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository: * Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: ```shell git push origin --delete my-fix-branch ``` * Check out the master branch: ```shell git checkout master -f ``` * Delete the local branch: ```shell git branch -D my-fix-branch ``` * Update your master with the latest upstream version: ```shell git pull --ff upstream master ``` ## Coding Rules To ensure consistency throughout the source code, keep these rules in mind as you are working: * All features or bug fixes **must be tested** by one or more specs (unit-tests). * All public API methods **must be documented**. * We follow [Google's Java Style Guide](https://github.com/google/google-java-format]). An automated formatter is available, see [spotless](https://github.com/diffplug/spotless). ## Commit Message Format *This specification is inspired by and supersedes the [AngularJS commit message format][commit-message-format].* We have very precise rules over how our Git commit messages must be formatted. This format leads to **easier to read commit history**. Each commit message consists of a **header**, a **body**, and a **footer**. ```