mirror_maker
/
soapbox
mirror of https://gitlab.com/soapbox-pub/soapbox
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Rewrite contributing docs

Browse Source
environments/review-dev-backen-cseal4/deployments/574
Alex Gleason 2 years ago
parent 796cbcbc15
commit 3de03d9d56
No known key found for this signature in database
GPG Key ID: 7211D1F99744FBB7
1 changed files with 32 additions and 53 deletions
Show Stats Download Patch File Download Diff File

85
docs/contributing.md
Unescape View File

@ -1,55 +1,34 @@
# Contributing to Soapbox # Contributing to Soapbox
When contributing to Soapbox, please first discuss the change you wish to make via issue, Thank you for your interest in Soapbox!
email, or any other method with the owners of this repository before making a change.
When contributing to Soapbox, please first discuss the change you wish to make by [opening an issue](https://gitlab.com/soapbox-pub/soapbox-fe/-/issues).
## Project Contribution Flow
## Opening an MR (merge request)
It is recommended that you use the following guidelines to contribute to the Soapbox project:
1. Smash that "fork" button on GitLab to make a copy of the repo.
* Understand recommended [GitLab Flow](https://www.youtube.com/watch?v=InKNIvky2KE) methods on branch management 2. Clone the repo locally, then begin work on a new branch (eg not `develop`).
* Use the following branch management process: 3. Push your branch to your fork.
* Pull a fork 4. Once pushed, GitLab should provide you with a URL to open a new merge request right in your terminal. If not, do it [manually](https://gitlab.com/soapbox-pub/soapbox-fe/-/merge_requests/new).
* Mirror the fork against the original repository, setting the mirror to only mirror to protected branches
* Set the master branch in your fork to Protected ### Ensuring the CI pipeline succeeds
* Never modify the master branch in your fork, so that your fork mirroring does not break
* Pull branches in your fork to solve specific issues When you push to a branch, the CI pipeline will run.
* Do merge requests only to the original repository master branch, so that your fork mirroring does not break
* If you don't use the above policy, when your mirrored fork breaks mirroring, you can force your fork to back to successful mirroring using the following process: [Soapbox uses GitLab CI](https://gitlab.com/soapbox-pub/soapbox-fe/-/blob/develop/.gitlab-ci.yml) to lint, run tests, and verify changes.
* Unprotect the master branch of your fork from force push It's important this pipeline passes, otherwise we cannot merge the change.
* Use the following git commands from the cmd line of your local copy of your fork's master branch
``` New users of gitlab.com may see a "detatched pipeline" error.
git remote add upstream /url/to/original/repo If so, please check the following:
git fetch upstream
git checkout master 1. Your GitLab email address is confirmed.
git reset --hard upstream/master 2. You may have to have a credit card on file before the CI job will run.
git push origin master --force
``` ## Text editor
* Re-protect the master branch of your fork from force push
We recommend developing Soapbox with [VSCodium](https://vscodium.com/) (or its proprietary ancestor, [VS Code](https://code.visualstudio.com/)).
## Pull Request Process
This will help give you feedback about your changes _in the editor itself_ before GitLab CI performs linting, etc.
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build. When this project is opened in Code it will automatically recommend extensions.
2. Update the README.md with details of changes to the interface, this includes new environment See [`.vscode/extensions.json`](https://gitlab.com/soapbox-pub/soapbox-fe/-/blob/develop/.vscode/extensions.json) for the full list.
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
## Text Editor Tools
If you're using a text editor like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/), you can install tools to help you get linter feedback while you write code for the Soapbox project.
For Atom, you can install the following packages:
* [linter](https://atom.io/packages/linter)
* [linter-ui-default](https://atom.io/packages/linter-ui-default)
* [linter-eslint](https://atom.io/packages/linter-eslint)
* [linter-stylelint](https://atom.io/packages/linter-stylelint)
For Visual Studio Code, you can install the following extensions:
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
* [vscode-stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)

Write Preview
Loading…
Cancel
Save