Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md, closes #985 #992 #1160

Merged
merged 5 commits into from
Feb 13, 2021
Merged

Updated README.md, closes #985 #992 #1160

merged 5 commits into from
Feb 13, 2021

Conversation

sreichel
Copy link
Contributor

@sreichel sreichel commented Aug 22, 2020

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Questions or comments

  • its WIP
  • help wanted
  • ...

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All automated tests passed successfully (all builds are green)

- add branch alias to composer.json (see #992#issuecomment-638974892)
- add AFL 3.0 license
- removed duplicate LICENSE.html
- ...
@github-actions github-actions bot added composer Relates to composer.json documentation labels Aug 22, 2020
kkrieger85
kkrieger85 previously approved these changes Sep 1, 2020
Copy link
Contributor

@kkrieger85 kkrieger85 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. Thx

tmotyl
tmotyl previously approved these changes Sep 1, 2020
Copy link
Contributor

@Flyingmana Flyingmana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use something else than "dev-master"

Master is a deprecated term/phrase. Following githubs naming here, "dev-main" would be an appropriate alternative.

@sreichel sreichel dismissed stale reviews from tmotyl and kkrieger85 via 1e16bb8 September 3, 2020 12:43
@colinmollenhour
Copy link
Member

Looks good! No objections.

On the section for "If you want to contribute to the project:" what about mentioning the one-step dev environment by either adding a link to the README or adding the command to the list of shell commands given?

# Step 1: clone your fork
git clone https://github.com/<YOUR GIT USERNAME>/magento-lts
cd magento-lts
git remote add upstream https://github.com/OpenMage/magento-lts
git pull upstream 1.9.4.x

# Step 2: start the dev environment
dev/openmage/install.sh

# Step 3: hack some improvements and create a Pull Request
git checkout -b your-branch
git add -A
git commit
git push origin your-branch

README.md Show resolved Hide resolved
@sreichel
Copy link
Contributor Author

what about mentioning the one-step dev environment

@colinmollenhour Absolutely, but I'd like to leave that up to you. I would prefer the link to a README, this one you can manage yourself without needing PRs here.

@kkrieger85 kkrieger85 requested a review from Flyingmana January 23, 2021 16:07
@Flyingmana Flyingmana merged commit ca98fed into OpenMage:1.9.4.x Feb 13, 2021
@github-actions
Copy link
Contributor

Unit Test Results

1 files  ±0  1 suites  ±0   0s ⏱️ ±0s
0 tests ±0  0 ✔️ ±0  0 💤 ±0  0 ❌ ±0 
2 runs  ±0  2 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ca98fed. ± Comparison against base commit bbd05be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
composer Relates to composer.json documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Around Version Numbers
5 participants