Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.69 KB

CONTRIBUTING.MD

File metadata and controls

56 lines (41 loc) · 2.69 KB
Raw

Contribute to Made. for Developers

Anyone, regardless of discipline, is encouraged to contribute to Made. We welcome everything from copy edits and bug fixes to new components.

Propose an update or new feature

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

Simply open an issue for requesting a new feature by clicking on the Issues tab above.

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 clicking on the Issues tab above. and provide the following information:

Start contributing

Please see contributing guide in each project for more information:

What is the contribution process?

  1. Issue: Check repo for an existing issue related to your contribution first. If none exist, open a new issue.
  2. Development environment: If you haven't already, fork and clone whichever repo you want to contribute to. Then, create a new branch and add your contribution in it.
  3. Pull request: Submit a PR. Be sure to fill out the template properly.
  4. Approval: Get PR approved by design and developers, or make any necessary changes for approval. This process may be quick or take a few iterations of feedback-update.
  5. Documentation: After design and dev have approved and merged PR, update any website documentation if necessary. One of the best examples for this is if you're contributing to component work which has website documentation related to your contribution.

Here are some contribution quick tips:

  • Do check repos for existing issues.
  • Do fill out the required template for contributions entirely; this pertains to both issues and PRs.
  • Do follow existing coding and writing styles.
  • Do follow proper commit messages syntax.
  • Do not branch off another branch.
  • Do not include unrelated changes in the same PR.
  • Do not create one massive PR if it can be broken up into smaller PRs.