Skip to content

Commit

Permalink
docs: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
theoludwig committed Nov 21, 2023
1 parent 367b434 commit ee4abf9
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 💡 Contributing

Thanks a lot for your interest in contributing to **editorconfig-checker.javascript**! 🎉

## Open Development

All work on **editorconfig-checker.javascript** happens directly on [GitHub](https://github.com/editorconfig-checker/editorconfig-checker.javascript). Both core team members and external contributors send pull requests which go through the same review process.

## Types of contributions

- Reporting a bug.
- Suggest a new feature idea.
- Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).
- Improve structure/format/performance/refactor/tests of the code.

## Pull Requests

- **Please first discuss** the change you wish to make via [issue](https://github.com/editorconfig-checker/editorconfig-checker.javascript/issues) before making a change. It might avoid a waste of your time.

- Ensure your code respect linting.

- Make sure your **code passes the tests**.

If you're adding new features to **editorconfig-checker.javascript**, please include tests.

## Commits

The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.

0 comments on commit ee4abf9

Please sign in to comment.