Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

57 lines (41 loc) · 3.1 KB
Raw

Contributing to C5

First of all, thank you for taking your time to contribute to C5 🎉

Contributing to C5 is really simple. Whatever you want to do with C5, just look up the appropriate section and follow the steps.

👥 But first, please take a look at our Code of Conduct.

Issues

⚠️ C5 doesn't compile / problems with versions

  1. Create a compatibility issue.

  2. Write a concise title, as descriptive as possible.

  3. Describe your problem. It is really important that you tell us your:

    • C5 version.
    • Visual Studio version (VS Code, VS 2019...).
    • Target framework (.NET 5.0). To find it, right click on your solution and Properties.
    • Operating System, specially if you are using Mono in a Unix environment.
    • Unity version, in case you are using that platform.
    • Any error displayed on the console log.

  4. Wait until getting some answer back! If you can solve it by yourself, please, publish and document your solution. Contributions as pull requests thereafter are welcome.

🐛 Hey, bug detected!

  1. Create a bug report issue.
  2. Write a concise title, as descriptive as possible.
  3. Make sure that your problem is a bug.
    • If you are struggling with setting up an environment with C5, please look at the previous section.
    • If you are requesting new functionalities or enhancing existing core, please look at the next section.
  4. Describe your problem.
    • Enumerate the steps to reproduce the problem.
    • Using minimum-working examples of code (potentially less than 10 lines) is a good way to explain the issue.
    • Try to identify the clashing classes or files.
  5. In case you are willing to solve the problem, see section Contributing.

💡 Missing functionalities / Improving existing functionalities

  1. Create a feature request issue.
  2. Write a concise title, as descriptive as possible.
  3. Explain what you think that is missing in C5: explain the feature and the solution and its alternatives you've thought about.

❓ Questions

  1. Create a question issue.
  2. Ask your question. That's it!

Contributing

  1. Fork the repository.
  2. Make your changes (commits) until you're done.
  3. Run all tests (Ctrl+R+A). If any fails, solve your bug and/or refactor your code.
  4. When all tests are green, commit your changes. Write a descriptive commit message. Go back to step 2 as much as you want.
  5. Push your changes.
  6. Create a pull request. Write a little description of your changes.