Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Meta: Contributing guide & Code of conduct #47

Merged
merged 4 commits into from
Mar 4, 2022
Merged

Meta: Contributing guide & Code of conduct #47

merged 4 commits into from
Mar 4, 2022

Conversation

ruben-iteng
Copy link
Collaborator

Add: Contributing guide & Code of conduct

Description

Add contents to the previous empty files + added empty file for coding guide to prevent dead links.

Fixes #34 & #16

PR type

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

Checklist

Please read and execute the following:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Code of Conduct

By submitting this issue, you agree to follow our Code of Conduct:

  • I agree to follow this project's Code of Conduct

Contact info (optional)

-

@ruben-iteng ruben-iteng added 📄 area: documentation Improvements or additions to documentation ⭐ goal: addition Addition of new feature 🟩 priority: low Low priority and doesn't need to be rushed labels Mar 4, 2022
@ruben-iteng ruben-iteng self-assigned this Mar 4, 2022
@ruben-iteng ruben-iteng added this to the Release 1.0.0 milestone Mar 4, 2022
IoannisP-ITENG
IoannisP-ITENG suggested changes Mar 4, 2022
View reviewed changes
Copy link
Contributor

@IoannisP-ITENG IoannisP-ITENG left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!
Looks pretty good.
Just fix those two typos and we can merge.

docs/CONTRIBUTING.md Outdated

## Contribution process

Please follow these steps to make a contribution to Faebryk:
Copy link
Contributor

Choose a reason for hiding this comment

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

s/Faebryk/faebryk

docs/CONTRIBUTING.md Outdated

## Creating a new issue

To make it easy for you to fill in all the nececeiry information, we make use of [Github forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms).
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: nececeiry

@IoannisP-ITENG IoannisP-ITENG changed the title Add: Contributing guide & Code of conduct Meta: Contributing guide & Code of conduct Mar 4, 2022
@IoannisP-ITENG IoannisP-ITENG changed the title Meta: Contributing guide & Code of conduct Contributing guide & Code of conduct Mar 4, 2022
@IoannisP-ITENG IoannisP-ITENG changed the title Contributing guide & Code of conduct Meta: Contributing guide & Code of conduct Mar 4, 2022
@IoannisP-ITENG IoannisP-ITENG merged commit bd746b9 into faebryk:main Mar 4, 2022
@IoannisP-ITENG IoannisP-ITENG mentioned this pull request Mar 4, 2022
Closed
@ruben-iteng ruben-iteng deleted the feature/add_docs branch March 4, 2022 12:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@IoannisP-ITENG IoannisP-ITENG Awaiting requested review from IoannisP-ITENG

Assignees

@ruben-iteng ruben-iteng

Labels
📄 area: documentation Improvements or additions to documentation ⭐ goal: addition Addition of new feature 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Milestone
Release 1.0.0
Development

Successfully merging this pull request may close these issues.

Add code of conduct
2 participants
@ruben-iteng @IoannisP-ITENG