Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

44 lines (34 loc) · 3.47 KB
Raw

How to contribute?

Your contributions to ADHDmail are very welcome. If you find a bug, please raise it as an issue. Even better fix it and send a pull request. If you like to help out with existing bugs and feature requests just check out the list of issues and grab and fix one. Some of the issues are labeled as as jump in. These issues are generally low hanging fruit so you can start with easier tasks.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

Getting started

This project uses C# 7 language features and SDK-style projects, so you'll need any edition of Visual Studio 2017 to open and compile the project. The free Community Edition will work.

Contribution guideline

This project uses GitHub flow for pull requests. So if you want to contribute, fork the repo, preferably create a local branch, based off of the dev branch to avoid conflicts with other activities, fix an issue, and send a PR. If you are new to git, here is a guide to forking and cloning a repository.

Pull requests are code reviewed. Here is a checklist you should tick through before submitting a pull request:

  • Here is a checklist you should tick through before submitting a pull request:
  • Implementation is clean
  • Code adheres to the existing coding standards; e.g. no curlies for one-line blocks, no redundant empty lines between methods or code blocks, spaces rather than tabs, etc. Full conventions can be found here.
  • There is proper unit test coverage
  • If the code is copied from StackOverflow (or a blog or OSS) full disclosure is included. That includes required license files and/or file headers explaining where the code came from with proper attribution
  • There are very few or no comments (because comments shouldn't be needed if you write clean code)
  • XML documentation is added/updated for the addition/change
  • Your PR is (re)based on top of the latest commits from the dev branch (more info below)
  • Link to the issue(s) you're fixing from your PR description. Use fixes #<the issue number>
  • Readme is updated if you change an existing feature or add a new one

Please rebase your code on top of the latest dev branch commits. Before working on your fork make sure you pull the latest so you work on top of the latest commits to avoid merge conflicts. Also before sending the pull request please rebase your code as there is a chance there have been new commits pushed after you pulled last. Please refer to this guide if you're new to git.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Source for most of this text: https://github.com/Humanizr/Humanizer/blob/master/CONTRIBUTING.md