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

Update the CONTRIBUTING GUIDE #3327

Merged
merged 3 commits into from
May 27, 2019
Merged

Update the CONTRIBUTING GUIDE #3327

merged 3 commits into from
May 27, 2019

Conversation

soupette
Copy link
Contributor

@soupette soupette commented May 27, 2019

⚠️ We have stopped merging PRs for now to the Strapi core.


The reason is that we are developing new architecture for the admin panel and for the plugins.

This new architecture will provide stability of the Strapi core as we approach the release of Beta.

We appreciate and welcome all your contributions, but until further notice, please do not submit a PR as it will not be merged.

Furthermore, you will have to rewrite it based on the new architecture.

Description:

This PR updates the CONTRIBUTING GUIDE to reflect the new development workflow.

My PR is a:

  • 💥 Breaking change
  • 🐛 Bug fix #issueNumber
  • 💅 Enhancement
  • 🚀 New feature

Main update on the:

  • Admin
  • Documentation
  • Framework
  • Plugin

Manual testing done on the following databases:

  • Not applicable
  • MongoDB
  • MySQL
  • Postgres
  • SQLite

CONTRIBUTING.md Outdated
@@ -14,214 +8,143 @@ Strapi is an open-source project administered by [the Strapi team](https://strap

Before contributing, ensure that your effort is aligned with the project's roadmap by talking to the maintainers, especially if you are going to spend a lot of time on it. Feel free to [join us on Slack](http://slack.strapi.io) if you are interested in helping us or [drop us an email](mailto:hi@strapi.io) if you are interested in working with us.
Copy link
Member

Choose a reason for hiding this comment

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

If you are interesting in helping us or working with us

CONTRIBUTING.md Outdated

If you send a pull request, please do it against the `master` branch. We are developing upcoming versions separately to ensure non-breaking changes from master to the latest stable major version.
We are using [GitHub Issues](https://github.com/strapi/strapi/issues) to manage our public bugs. We keep a close eye on this so before filling a new task try to make sure the problem doesn't already exist.
Copy link
Member

Choose a reason for hiding this comment

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

so before filling a new issue, try to make sur it does not already exist

CONTRIBUTING.md Outdated

[Go to the repository](https://github.com/strapi/strapi) and fork it to your own GitHub account.
**Before submitting your pull request** make sure the following requirements are done:
Copy link
Member

Choose a reason for hiding this comment

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

the following requirements are fullfilled

CONTRIBUTING.md Outdated

#### 3. ⏳ Installation
- You have [Node](https://nodejs.org/en/) at v8.0.0+ and [Yarn](https://yarnpkg.com/en/) at v1.2.0+.
Copy link
Member

Choose a reason for hiding this comment

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

Node v10 only ?

Copy link
Member

Choose a reason for hiding this comment

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

I agree node v10 for now, node 11 is not an LTS it's a dev version and node 12 isn't LTS until october:
image

@alexandrebodin
Copy link
Member

@renatodex Yarn is now required to contribute as we are exploiting the yarn workspaces feature to manage the monorepo

@alexandrebodin alexandrebodin added this to the 3.0.0-beta milestone May 27, 2019
@alexandrebodin alexandrebodin self-assigned this May 27, 2019
@alexandrebodin alexandrebodin merged commit 91bce1f into beta May 27, 2019
@alexandrebodin alexandrebodin deleted the update-contributing branch May 27, 2019 19:59
Copy link
Contributor

@davidkartuzinski davidkartuzinski left a comment

Choose a reason for hiding this comment

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

Please comments. A few typos and a few recommendations/questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
source: docs Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants