Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 2.08 KB

README.md

File metadata and controls

59 lines (34 loc) · 2.08 KB
Raw

cyberyen.org

An open-source website, open to contributions from any developer.

Report problems or help improve the site by opening a new issue or submitting pull request.

Contributing

All regular activity is organized through a public pull request process and managed by the site co-maintainers. To get started contributing to cyberyen.org, please review the Contribution Guidelines.

Local Development

Before you begin, ensure you have the following software installed:

1. Fork the Repository

Fork the cyberyen.org GitHub repository to your GitHub account.

2. Clone the Repository

Clone your forked repository to your local machine:

git clone https://github.com/<YOUR_GITHUB_USERNAME>/cyberyen.org.git
cd cyberyen.org

3. Install Dependencies

Navigate to the project directory and install the required dependencies:

yarn install

4. Start the Development Server

Start the development server to see your changes live:

yarn run dev

Open your browser and go to http://localhost:3000 to view the website.

5. Open a Pull Request

Open a pull request (PR) from your forked repository's branch to the master branch of the original repository. In your PR description, provide a clear explanation of the changes you have made and the reasons behind them.

6. Code Review

Your pull request will undergo a code review by the maintainers. Be patient and responsive to any feedback or changes requested.

Development Discussion

Discussions regarding development occur on GitHub and in the #cyberyen.org Matrix room. Active participation in these plateforms is encouraged to stay updated and to collaborate effectively with other developers.