Skip to content

Commit

Permalink
chore: add contribution guidelines + Code of Conduct (PygmalionAI#507)
Browse files Browse the repository at this point in the history
* add utils; proper project structuring

* add contributing guidelines and CoC
  • Loading branch information
AlpinDale committed Jun 12, 2024
1 parent 0178b4d commit e7ea38f
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 2 deletions.
85 changes: 85 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
## Aphrodite Engine Code of Conduct

Inspired by the [SQLite CoE](https://sqlite.org/codeofethics.html).

### Purpose
The maintainer of Aphrodite Engine, at the time of writing this document, has pledged to govern his actions with other contributors, with his clients, and with the larger Aphrodite Engine community in accordance with the "instruments of good works" from chapter 4 of [The Rule of St. Benedict](https://en.wikipedia.org/wiki/Rule_of_Saint_Benedict) (hereafter referred to as "The Rule"). This code of ethics has proven its mettle in thousands of diverse communities for over 1,500 years, and has served as a baseline for many civil law codes since the time of Charlemagne.

#### Scope of Application
No one is required to follow The Rule, to know The Rule, or even to think that The Rule is a good idea. The maintainer of Aphrodite Engine believes that anyone who follows The Rule will live a happier and more productive life, but individuals are free to dispute or ignore the advice if they wish.

The maintainer of Aphrodite Engine has pledged to follow the spirit of The Rule to the best of his ability. He views The Rule as his promise to all Aphrodite Engine users of how developers are expected to behave. This is a one-way promise, or covenant. In other words, he is saying: "I will treat you this way regardless of how you treat me."

### The Rule
0. First of all, love the Lord God with your whole heart, your whole soul, and your whole strength.
1. Then, love your neighbor as yourself.
2. Do not murder.
3. Do not commit adultery.
4. Do not steal.
5. Do not covet.
6. Do not bear false witness.
7. Honor all people.
8. Do not do to another what you would not have done to yourself.
9. Deny oneself in order to follow Christ.
10. Chastise the body.
11. Do not become attached to pleasures.
12. Love fasting.
13. Relieve the poor.
14. Clothe the naked.
15. Visit the sick.
16. Bury the dead.
17. Be a help in times of trouble.
18. Console the sorrowing.
19. Be a stranger to the world's ways.
20. Prefer nothing more than the love of Christ.
21. Do not give way to anger.
22. Do not nurse a grudge.
23. Do not entertain deceit in your heart.
24. Do not give a false peace.
25. Do not forsake charity.
26. Do not swear, for fear of perjuring yourself.
27. Utter only truth from heart and mouth.
28. Do not return evil for evil.
29. Do no wrong to anyone, and bear patiently wrongs done to yourself.
30. Love your enemies.
31. Do not curse those who curse you, but rather bless them.
32. Bear persecution for justice's sake.
33. Be not proud.
34. Be not addicted to wine.
35. Be not a great eater.
36. Be not drowsy.
37. Be not lazy.
38. Be not a grumbler.
39. Be not a detractor.
40. Put your hope in God.
41. Attribute to God, and not to self, whatever good you see in yourself.
42. Recognize always that evil is your own doing, and to impute it to yourself.
43. Fear the Day of Judgment.
44. Be in dread of hell.
45. Desire eternal life with all the passion of the spirit.
46. Keep death daily before your eyes.
47. Keep constant guard over the actions of your life.
48. Know for certain that God sees you everywhere.
49. When wrongful thoughts come into your heart, dash them against Christ immediately.
50. Disclose wrongful thoughts to your spiritual mentor.
51. Guard your tongue against evil and depraved speech.
52. Do not love much talking.
53. Speak no useless words or words that move to laughter.
54. Do not love much or boisterous laughter.
55. Listen willingly to holy reading.
56. Devote yourself frequently to prayer.
57. Daily in your prayers, with tears and sighs, confess your past sins to God, and amend them for the future.
58. Fulfill not the desires of the flesh; hate your own will.
59. Obey in all things the commands of those whom God has placed in authority over you even though they (which God forbid) should act otherwise, mindful of the Lord's precept, "Do what they say, but not what they do."
60. Do not wish to be called holy before one is holy; but first to be holy, that you may be truly so called.
61. Fulfill God's commandments daily in your deeds.
62. Love chastity.
63. Hate no one.
64. Be not jealous, nor harbor envy.
65. Do not love quarreling.
66. Shun arrogance.
67. Respect your seniors.
68. Love your juniors.
69. Pray for your enemies in the love of Christ.
70. Make peace with your adversary before the sun sets.
71. Never despair of God's mercy.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Contributing Guidelines for Aphrodite Engine

Aphrodite Engine welcomes any and all contributors to submit fixes, features, issues - no matter the scope.

### Code of Ethics
If you wish, you can read the [Aphrodite Engine Code of Conduct](./CODE_OF_CONDUCT.md). You don't need to follow it! :)

### Setup
For development, you will need to build the engine from source.

```sh
pip install -e .
pip install -r requirements-dev.txt
```

Make sure you build in editable mode with `-e`.

Our test units at the moment are incomplete, so you can skip test units for now.

After submitting a patch, make sure to run the linter/formatter before asking for a review:

```sh
sh ./formatting.sh
```

Thank you for your interest in Aphrodite Engine!
4 changes: 2 additions & 2 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ ENV CUDA_HOME=/usr/local/cuda

ENV HF_HOME=/tmp
ENV NUMBA_CACHE_DIR=$HF_HOME/numba_cache
ENV TORCH_CUDA_ARCH_LIST="6.1 7.0 7.5 8.0 8.6 8.9 9.0+PTX"
ENV TORCH_CUDA_ARCH_LIST="6.0 6.1 7.0 7.5 8.0 8.6 8.9 9.0+PTX"
RUN python3 -m pip install --no-cache-dir -e .

# Workaround to properly install flash-attn. For reference
Expand All @@ -44,7 +44,7 @@ ENTRYPOINT ["/app/aphrodite-engine/docker/entrypoint.sh"]

EXPOSE 7860

# Service UID needs write access to $HOME to create temporary folders, see #458
# Service UID needs write access to $HOME to create temporary folders, see #458
RUN chown 1000:1000 ${HOME}

USER 1000:0
Expand Down

0 comments on commit e7ea38f

Please sign in to comment.