-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from Mastercard/feature/docs-update
docs: add contribution.md and update getting started
- Loading branch information
Showing
2 changed files
with
39 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters