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

Add new Contribution guidelines #1237

Merged
merged 5 commits into from
Jul 15, 2020

Conversation

jaladh-singhal
Copy link
Member

@jaladh-singhal jaladh-singhal commented Jul 14, 2020

This contribution guidelines page is specifically written in informal way to get a new contributor motivated. Besides, it's purposedly kept short-average length (pointing to other guidelines where required) to not to overwhelm new contributor. A good checklist to cross-check what I have written here can be tips in this article - let me know what did I miss and any other improvements.

Demo of how this looks after rendering: https://github.com/jaladh-singhal/tardis/blob/contrib-guide/CONTRIBUTING.md

To-dos

  • Create issue for creating doc pages/guidelines for void links i.e marked by # only
  • Create issue for updating running tests guidelines (i.e. outdated) which is used here
  • Put the removed commit message guidelines at somewhere else, let me know where?

@codecov
Copy link

codecov bot commented Jul 14, 2020

Codecov Report

Merging #1237 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1237   +/-   ##
=======================================
  Coverage   80.63%   80.63%           
=======================================
  Files          41       41           
  Lines        3424     3424           
=======================================
  Hits         2761     2761           
  Misses        663      663           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2c68286...fb08a2e. Read the comment docs.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
marxwillia and others added 2 commits July 15, 2020 09:16
Co-authored-by: Wolfgang Kerzendorf <wkerzendorf@gmail.com>
Co-authored-by: Wolfgang Kerzendorf <wkerzendorf@gmail.com>
@wkerzendorf wkerzendorf merged commit 56f6acd into tardis-sn:master Jul 15, 2020
ebjordi pushed a commit to ebjordi/tardis that referenced this pull request Jul 17, 2020
* Added new contributing guidelines

* Added symlink of Contributing.md to Contribting to TARDIS section

* Fixed sym link

* Update CONTRIBUTING.md

Co-authored-by: Wolfgang Kerzendorf <wkerzendorf@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Wolfgang Kerzendorf <wkerzendorf@gmail.com>

Co-authored-by: Marc Williamson <marxwillia@gmail.com>
Co-authored-by: Wolfgang Kerzendorf <wkerzendorf@gmail.com>
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* Added new contributing guidelines

* Added symlink of Contributing.md to Contribting to TARDIS section

* Fixed sym link

* Update CONTRIBUTING.md

Co-authored-by: Wolfgang Kerzendorf <wkerzendorf@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Wolfgang Kerzendorf <wkerzendorf@gmail.com>

Co-authored-by: Marc Williamson <marxwillia@gmail.com>
Co-authored-by: Wolfgang Kerzendorf <wkerzendorf@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants