markdownlint-rule-relative-.../CONTRIBUTING.md
2023-05-13 16:03:06 +02:00

1.4 KiB

💡 Contributing

Thanks a lot for your interest in contributing to markdownlint-rule-relative-links! 🎉

Code of Conduct

markdownlint-rule-relative-links adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

Open Development

All work on markdownlint-rule-relative-links happens directly on this repository. 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 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 markdownlint-rule-relative-links, please include tests.

Commits

The commit message guidelines adheres to Conventional Commits and Semantic Versioning for releases.