|
| 1 | +# Contributing to Transcriptase |
| 2 | +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: |
| 3 | + |
| 4 | +- Reporting a bug |
| 5 | +- Discussing the current state of the code |
| 6 | +- Submitting a fix |
| 7 | +- Proposing new features |
| 8 | +- Becoming a maintainer |
| 9 | + |
| 10 | +## Any contributions you make will be under the MIT Software License |
| 11 | +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. |
| 12 | + |
| 13 | +## Report bugs using Github's [issues](https://github.com/gobeam/truthy-react-frontend/issues) |
| 14 | + |
| 15 | +Documentation |
| 16 | +------------- |
| 17 | + |
| 18 | +If you contribute anything that changes the behavior of the application, |
| 19 | +document it in the follow places as applicable: |
| 20 | +* the code itself, through clear comments and unit tests |
| 21 | +* [README](README.md) |
| 22 | + |
| 23 | +This includes new features, additional variants of behavior, and breaking |
| 24 | +changes. |
| 25 | + |
| 26 | +Testing |
| 27 | +------- |
| 28 | + |
| 29 | +Proper test are encouraged. |
| 30 | + |
| 31 | +Issues |
| 32 | +------ |
| 33 | + |
| 34 | +For creating an issue: |
| 35 | +* **Bugs:** please be as thorough as possible, with steps to recreate the issue |
| 36 | + and any other relevant information. |
| 37 | +* **Feature Requests:** please include functionality and use cases. If this is |
| 38 | + an extension of a current feature, please include whether or not this would |
| 39 | + be a breaking change or how to extend the feature with backwards |
| 40 | + compatibility. |
| 41 | +* **Security Vulnerability:** please report it at |
| 42 | + https://my.xfinity.com/vulnerabilityreport and contact the [maintainers](MAINTAINERS.md). |
| 43 | + |
| 44 | +If you wish to work on an issue, please assign it to yourself. If you have any |
| 45 | +questions regarding implementation, feel free to ask clarifying questions on |
| 46 | +the issue itself. |
| 47 | + |
| 48 | +Pull Requests |
| 49 | +------------- |
| 50 | + |
| 51 | +Good pull requests - patches, improvements, new features - are a fantastic |
| 52 | +help. They should remain focused in scope and avoid containing unrelated |
| 53 | +commits. |
| 54 | + |
| 55 | +**Please ask first** before embarking on any significant pull request (e.g. |
| 56 | +implementing features, refactoring code, porting to a different language), |
| 57 | +otherwise you risk spending a lot of time working on something that the |
| 58 | +project's developers might not want to merge into the project. |
| 59 | + |
| 60 | +Please adhere to the coding conventions used throughout a project (indentation, |
| 61 | +accurate comments, etc.) and any other requirements (such as test coverage). |
| 62 | + |
| 63 | +Since the `main` branch is what people actually use in production, we have a |
| 64 | +`dev` branch that unstable changes get merged into first. Only when we |
| 65 | +consider that stable we merge it into the `main` branch and release the |
| 66 | +changes for real. |
| 67 | + |
| 68 | +Adhering to the following process is the best way to get your work |
| 69 | +included in the project: |
| 70 | + |
| 71 | +1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, and configure the remotes: |
| 72 | + |
| 73 | + ```bash |
| 74 | + # Clone your fork of the repo into the current directory |
| 75 | + git clone https://github.com/<your-username>/truthy-react-frontend.git |
| 76 | + # Navigate to the newly cloned directory |
| 77 | + cd truthy-react-frontend |
| 78 | + # Assign the original repo to a remote called "upstream" |
| 79 | + git remote add upstream https://github.com/gobeam/truthy-react-frontend.git |
| 80 | + ``` |
| 81 | + |
| 82 | +2. If you cloned a while ago, get the latest changes from upstream: |
| 83 | + |
| 84 | + ```bash |
| 85 | + git checkout dev |
| 86 | + git pull upstream dev |
| 87 | + ``` |
| 88 | + |
| 89 | +3. Create a new topic branch (off the `dev` branch) to contain your feature, change, or fix: |
| 90 | + |
| 91 | + ```bash |
| 92 | + git checkout -b <topic-branch-name> |
| 93 | + ``` |
| 94 | + |
| 95 | +4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/about-git-rebase/) feature to tidy up your commits before making them public. |
| 96 | +
|
| 97 | +5. Locally merge (or rebase) the upstream dev branch into your topic branch: |
| 98 | +
|
| 99 | + ```bash |
| 100 | + git pull [--rebase] upstream dev |
| 101 | + ``` |
| 102 | +
|
| 103 | +6. Push your topic branch up to your fork: |
| 104 | +
|
| 105 | + ```bash |
| 106 | + git push origin <topic-branch-name> |
| 107 | + ``` |
| 108 | +
|
| 109 | +7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) |
| 110 | + with a clear title and description. |
| 111 | +
|
| 112 | +**IMPORTANT**: By submitting a patch, you agree to allow the project |
| 113 | +owners to license your work under the terms of the [MIT License](https://github.com/gobeam/truthy-react-frontend/blob/main/LICENSE.md). |
0 commit comments