Skip to content

Add guidelines for contributors to README #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sunnamed434 merged 3 commits into from
Jun 27, 2024
Merged

Add guidelines for contributors to README #86

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e2fd3cd
Add guidelines for contributors to README
sunnamed434 Jun 14, 2024
12fdfed
Update contributors guidelines
sunnamed434 Jun 27, 2024
69af792
Update contribution guildelines
sunnamed434 Jun 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,28 @@ Before you dive into making changes, consider creating an [issue][issues_url] or
- Collaborative Problem Solving: Other contributors might have valuable insights or alternative solutions. Discussing changes beforehand can lead to better implementations.
- Save Your Time: Avoid working on updates that might not align with the project's direction. Consult with others to ensure your efforts are fruitful.

### Guidelines for Contributors

Follow these guidelines to make our work smoother and faster, otherwise your change might not be accepted:

1. **Check for Compatibility**:
- Does your change break backward compatibility?
- If it does then your change might not accepted, keep it compatible with old versions.

2. **Ensure Broad Usability**:
- Will your changes work with other versions of Rocket or older versions, or if other Rocket for example [LDM][ldm_github_repository] installed but your edited version of RocketModFix is not installed?
- If not, your change may not be accepted as it could cause problems such as breaking changes.

3. **Test Your Changes**:
- Have you tested your change locally or in a test environment?
- If not, test it to confirm it works as expected.

4. **Keep Things Simple**:
- Do you keep things simple?
- If not, try to keep things simple, for example: "Don't try to make things/code unique, hard, complex, etc, use and do simple and working solutions for the issue, no need to show yourself as a hulk.".

Keep these points in mind to help everyone use RocketModFix without issues.

## NuGet Packages

### Redist
Expand Down Expand Up @@ -138,4 +160,5 @@ On the 2nd of June 2020 fr34kyn01535 requested the fork be rebranded to help dis

[discordserver_url]: https://discord.gg/z6VM7taWeG

[openmod_github_repository]: https://github.com/openmod/openmod
[openmod_github_repository]: https://github.com/openmod/openmod
[ldm_github_repository]: https://github.com/SmartlyDressedGames/Legally-Distinct-Missile