Skip to content

Commit

Permalink
Merge pull request #4 from Mastercard/feature/docs-update
Browse files Browse the repository at this point in the history
docs: add contribution.md and update getting started
  • Loading branch information
joseph-eccles authored Jan 11, 2023
2 parents a926ea0 + 467333a commit 2251a9c
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 3 deletions.
36 changes: 36 additions & 0 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contribute to Made. for Developers

Made is always evolving – thanks to you.

Every time you share bug fixes, components, or documentation with us, you’re helping us to understand your needs.

## Propose an update or new feature

Whether you’re proposing an update, a new feature or simply making something better, we welcome contribution.

Simply email an issue to <a href="mailto:[email protected]">[email protected]</a> and provide the following information:

- A brief description of the update you want to propose.
- Include mockups of any fidelity (optional)
- Include any inspirations from other products (optional)
- Once your request is raised, we’ll review and set up a meeting to discuss the proposal in greater detail.

We’ll cover the following:

- What exactly needs working on
- How much you’d like to contribute
- Support needed to get the job done
- Suitable timings that work for you
- If your work meets our contribution criteria, your request will be added to our backlog and marked as 'To do'.
At this stage, you can either start contribution or leave it for a member of the Made production team to pick up.


## Submit an issue or bug fix

To report bugs and leave feedback, open an issue on <a href="https://github.com/Mastercard/made/issues" target="_blank">GitHub</a> and provide the following information:

- A brief description of the fix you want to propose.
- What did you expect to happen? What happened instead? What would you like to see changed?
- What browser are you working in?
- Steps to reproduce the issue
- Additional information (Screenshots or code)
6 changes: 3 additions & 3 deletions storybook/stories/hello/GettingStarted.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ import { Meta, Canvas, Story } from "@storybook/addon-docs/blocks";

## Install

Made for Developers packages can be downloaded via the Mastercard GitHub.
Made for Developers packages can be downloaded via the <a href="https://github.com/Mastercard/made" target="_blank">Mastercard GitHub </a>.

Before moving further, please make sure you have Node.js installed on your machine.

If you're planning on using Made packages in a project that doesn't yet use Node Package Manager, you'll have to first create a package.json file. You can read more on how to do this in the npm documentation.

As Made. for Developers packages are hosted on the GitHub Packages you will need to to set your registry to point to the GitHub Packages repository.
As Made. for Developers packages are hosted on <a href="https://github.com/features/packages" target="_blank">GitHub Packages</a> you will need to to set your registry to point to the GitHub Packages repository.

To configure your project to use the GitHub Packages Registry run this the command line:
To configure your project to use the GitHub Packages Registry run this in the command line:

```
npm config set registry https://npm.pkg.github.com
Expand Down

0 comments on commit 2251a9c

Please sign in to comment.