Skip to content

Commit

Permalink
Update CONTRIBUTING for codacy
Browse files Browse the repository at this point in the history
  • Loading branch information
R0mb0 committed May 7, 2024
1 parent 88f7270 commit 82ed4f6
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,53 @@
Contributing
============
# Contributing

👍🎉 Thanks a lot for considering contributing 🎉👍

We welcome and encourage contribution. There is many way to contribute: you can
write bug report, contribute code or documentation.

Working on your first Pull Request?
-----------------------------------
## Working on your first Pull Request?

You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
You can learn how from this *free* series
[How to Contribute to an Open Source Project on GitHub]
(https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

Reporting issues
----------------
## Reporting issues

When reporting issues the more information you can supply the better.

If it is an issue with building the LaTeX package, indicate your environment like operating system and,
If it is an issue with building the LaTeX package, indicate your
environment like operating system and,
version of MikTeX your are using.

Improvements request and proposal
---------------------------------
## Improvements request and proposal

Feel free to make an issue to request a new functionality.

Contributing code/Pull-Request
------------------------------
## Contributing code/Pull-Request

We welcome contribution, this can be done by starting a pull-request.
You can contribute by updating the package content or styling, code (.cls file), or both.
You can contribute by updating the package content or styling, code (
.cls file), or both.

### Contributing content or styling

There is a couple of basic requirement for us to merge the pull request:
- The styling should maintain the compatibility with previous versions. For example, if you plan to
add a new number to the contact information, it should be optional and not mandatory allowing not to
change anything to the other users of the package.
- The styling should maintain the compatibility with previous versions. F
or example, if you plan to add a new number to the contact information,
it should be optional and not mandatory allowing not to change anything
to the other users of the package.

### Contributing code

If the change is big, typically if the change span to more than one file, consider starting an issue first to discuss the improvement.
If the change is big, typically if the change span to more than one file,
consider starting an issue first to discuss the improvement.
This will makes it much easier to make the change fit well into the package.

There is some basic requirement for us to merge a pull request:
- Describe the change
- Refer to any issues it effects
- Separate one pull request per functionality: if you start writing "and" in the feature description consider if it could be
separated in two pull requests.
- Describe the change
- Refer to any issues it effects
- Separate one pull request per functionality: if you start writing "and"
in the feature description consider if it could be separated in two pull requests.

In your code:
- Make sure the coding style of your code follows the style of the file.
- Make sure the coding style of your code follows the style of the file.

0 comments on commit 82ed4f6

Please sign in to comment.