Mirrors/awesome-framework
2
0
Fork 0
mirror of https://github.com/framewiki/awesome-framework synced 2024-11-10 10:54:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
awesome-framework/contributing.md
Josh Levin 1d846cddc2
typo fix
2022-11-24 09:03:45 -05:00

2.1 KiB
Raw Blame History

Home

Contributing

Be sure that you follow the Code of Conduct at all times.

Proposing Changes

  1. Propose changes by opening a GitHub Issue in this repository. Please indicate in the issue whether you want to make the change yourself or are proposing it for another contributer or maintainer.
  2. Discuss the proposal in the issue with maintainers and other members of the community to determine if it is a good fit for the repo.
  3. Wait for a maintainer will mark the issue as approved or denied. If it's approved, either you or another member of the community will be assigned to add it, and they can move on to the Making Changes section (below).

Making Changes

Warning

All pull requests must be associated with a GitHub issue that has been marked as approved as described above. Pull Requests without approved issues will be closed.

  1. Fork this repository.
  2. Make the suggested changes.
    • If the changes involve creating new markdown files, make a copy of the template file.
      • Add a link to the page in the appropriate place in the main README.md file.
  3. Open a Pull Request into the main branch of this repo.
    • Be sure to give your pull request a descriptive name and include a summary of what you changed in the body of the PR.
    • Ensure you use closing keyworks (i.e Closes #10) to link the Pull Request to the associated issue.
  4. Wait for review from maintainers and address any comments.
  5. Once a maintainer approves your changes, they will be merged into the main branch.
DISCLAIMER This repository and the resources within it are COMPLETELY UNOFFICIAL and not in any way endorsed or supported by Framework. Your use of these guides and projects is AT YOUR OWN RISK and MAY VOID YOUR WARRANTY. We ask that you do not reach out to Framework support about problems related to these resources, but you can feel free to reach out to the community maintainers via GitHub Discussions or Issues within this repository.