Skip to content

Commit

Permalink
Add contribution tips for new users.
Browse files Browse the repository at this point in the history
  • Loading branch information
Vagr9K committed Oct 23, 2021
1 parent 6772fea commit e63f032
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
In order to contribute to the repository:

- Fork the repository
- Clone your fork locally
- Install dependencies via `yarn` or `npm i`
- Make your changes and commit them
- Open your PR with the description of changes

The automated CI on PRs will help you with quality assurance, testing, best practices and accessibility issue detections.

You can also run it locally via commands:

- `yarn lint:all` or `npm run lint:all` in the root directory for linting
- `yarn type-check:watch` or `npm run type-check:watch` in the root directory for type checking via TypeScript
- `yarn test:e2e:dev` or `npm run test:e2e:dev` in the example project directories for running E2E test via Cypress
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,12 @@ CMS.init({

For NetlifyCMS specific issues visit the [official documentation](https://www.netlifycms.org/docs/intro/).

### Contributing

If you have any issues, questions or suggestions related to the starter then feel free to bring them up!

If you'd like to contribute to the repository and need some pointers, take a look at the [Contribution Guide](./.github/CONTRIBUTING.md).

# Author

Ruben Harutyunyan ([@Vagr9K](https://twitter.com/Vagr9K))

2 comments on commit e63f032

@github-actions
Copy link

Choose a reason for hiding this comment

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

@github-actions
Copy link

Choose a reason for hiding this comment

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

Please sign in to comment.